README.md

mycovidconnect

TABLE OF CONTENTS

1. Description.
2. Guidlelines
3. Installation
4. Running
5. Frameworks and servivices used
6. Contributing
7. Credits

1. Description

This is a part of project XCoV19 which aims to build a software that guides patients to the nearest hospital, while modeling the spread of the virus in order to better anticipate hospital needs. Here is the official page.

2. Project Setup Guidelines

---

• We use React;
• Know how to run tsc with babel: https://babeljs.io/blog/2018/08/27/7.0.0
• Lets agree on JS Guideline
  

---

In general follow this Javascript Styleguide

Always follow Guidelines!! Helps everyone who are trying to contribute.

3. Installation

Run docker image to start instance-

docker-compose -f "docker-compose.yml" up -d --build

Typescript to compile project. Babel does the transpiling from target to es5 browser compatible code, tsc does the type-checking. See this for more info on how to run babel projects using tsc.

4. Running

In order to run the app in development mode-

npm start

---

If you want to watch the build run compiler-

./node_modules/.bin/tsc -p tsconfig.json --watch

If you want more help on running the app using npm then type-

npm --help

or visit here

---

Open http://localhost:3000 to view it in the browser.

The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.

Check package.json for scripts on how to build and run.

---

5. Frameworks and services-

Frameworks-

1. React

Services-

1. Firebase
2. Docker

6. Contributing

Please read CONTRIBUTING.md before you help us!

7. Credits

(IN NO SPECIFIC ORDER)

codecakes

GeekySankar

akshayparmar90

MEME-MAN234