gaui / covid19

COVID-19 statistics for Iceland

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

COVID-19

This is a project that is aimed towards retrieving statistics about COVID-19. To begin with it's only for Iceland, but it will probably be expanded to other countries.

This project was just meant as a hobby project for fun while I'm unemployed.

Components

This is a monorepo with three components for abstraction.

  • Core
  • Web API (GraphQL)
  • App

Core

Core is the core of the system. It's a Node module with the data providers for the API.

The purpose behind the core is to abstract core fundamentals for the project, so it can be used somewhere else.

Web API

This is a GraphQL API that's built with NestJS and uses the Core for providing the data used.

App

The web application is built with React and uses Redux Toolkit for state management and Apollo Client as a GraphQL client.

Collaboration

If you would like to collaborate on this project, it's more than welcome!

Make sure you prepend commits with the following: [core], [api], [app] or nothing if it's a general change.

Also make sure you prefix each change according to (Conventional Commits)(https://www.conventionalcommits.org). See more details below.

  1. Fork the project.
  2. Make your changes.
  3. Make sure all tests pass: yarn test
  4. Make sure it passes linting: yarn lint
  5. Make sure it's formatted properly: yarn format
  6. Submit a PR and explain your changes.

Conventional Commits

We use (Conventional Commits)(https://www.conventionalcommits.org), Angular convention.

  • feat: - New feature.
  • fix: - Fix a bug.
  • refactor: - Refactoring, no breaking changes, just improving code.
  • style: - Styling changes.
  • test: - Automated tests.
  • chore: - Infrastructure and tooling.
  • docs: - Documentation.

Credits

Thanks go out to covid.is and NovelCOVID.

All collaborators will be listed here.

About

COVID-19 statistics for Iceland


Languages

Language:HTML 90.4%Language:TypeScript 7.5%Language:JavaScript 1.4%Language:CSS 0.5%Language:Shell 0.2%