/ncovi-detail

xem thống kê tình hình covid 19 tại Việt Nam và thế giới

Primary LanguageHandlebars

Contributors Forks Stargazers Issues LinkedIn


Logo

ncovi-detail

A project to statistic covid 19 data in VietNam and in the world
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

There are having many app with many data about the covid 19 data. We want to centralize them and make people have a overview for this dangerous disease.

Here's why:

  • Intuitive figures
  • Have a modern chart design to display data
  • A table to statistic all provinces

Use the README.md to get started and get more information.

(back to top)

Built With

NodeJS ExpressJS eslint Bootstrap Heroku

(back to top)

Getting Started

This is all steps to setup and build this project

Prerequisites

Below is all prerequisites for this project.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app.

  1. Check API status at api
  2. Clone the repo 
    git clone https://github.com/hhpr98/ncovi-detail.git
  3. Install NPM packages 
    npm install
  4. Open any terminal and start development mode 
    npm run dev

(back to top)

Usage

All documentation is available in Documentation

The deployment is available in Site

For more examples, please refer to the link

(back to top)

Roadmap

  • Add project architect
  • Implement skeleton UI (v1)
  • Implement UI (v1)
  • Deployed to host link
  • Upgrade to v2 with new API
  • Refactor new UI
  • Support mobile device
  • Added eslint check
  • Update documentation
  • Enhance UI
    • Support mobile resolution
    • Refactor NAV bar (icons and mobile resolution)
    • Add datetime that sync the data
    • Add modal to notify if can not get the data
    • Add icons
  • Fix bugs
    • UI bugs
    • Detection issues
  • Enhance lint check (add more rules)
  • Remove heroku deployment (not supported)
  • New deployment Railway
  • New deployment Cyclic
  • Remove railway deployment (payment required)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Hoa Nguyen - @hhpr98 - nguyenhuuhoa1998@gmail.com

Project Link: https://github.com/hhpr98/ncovi-detail

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)