Skip to content

Fusemachines/covid-nepal-web

Repository files navigation

Gitter

COVID-19 NEPAL

The project has 3 sub division to complete a full cycle

  1. COVID Nepal User
  2. COVID Nepal Backend
  3. COVID Nepal Admin for Data Validation

Quick Overview

This project was bootstrapped with Create React App.

Frontend Tech Stack

First time setup

After you have cloned the repo, move into the project directory and run the yarn command to install the dependencies

> cd covid-nepal-web
> yarn

The project needs .env file and can now be started by running the start script

> yarn start

Folder structure

covid-nepal-web
├── README.md
├── node_modules
├── OneSDK                            // push notification
├── package.json
├── .gitignore
├── editorconfig
├── .env                              // please check the sample env files
├── .sample.env
├── yarn.lock
├── public
│   ├── favicon.ico
│   ├── index.html
│   └── manifest.json
└── src
    ├── @types                        // user defined interfaces
    ├── components                    // common components
    ├── config                        // environment configuration
    ├── constants                     // routes and other constants included
    ├── customHooks
    ├── i18n                          // multi-language setup
    ├── interface
    ├── routes                        // routes defined
    ├── scss                          // stylesheet and sass
    ├── services                      // api calls
    ├── utils                         // utility functions
    ├── App.tsx
    ├── index.scss
    ├── react-app-env.d.ts
    ├── Router.tsx
    ├── index.tsx
    └── serviceWorker.ts
    ├── setupTest.ts

Available Scripts

yarn start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes. Your app is ready to be deployed! See the section about deployment for more information.

yarn format

Run prettier to make your code look all pretty. See the section about prettier for more information.

Learn More

You can learn more in the Create React App documentation. To learn React, check out the React documentation.

Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues in the hotlist: community-help. Thank you!

Reference from:

  1. Angular
  2. create-react-app

Stay In Touch

License

The source code is licensed under GPL v3. License is available here.

Copyright (c) 2020-present, Fusemachines

Started At and Supported By

Thanks to our Collaborators

Maintainers

Moderators

Do you want to be a moderator? Be part of the moderator team. Sign Up Now

Collaborators

This project follows the all-contributors specifications. Contributions of any kind is welcome!