TL;DR: Start Contributing right away:
If you are a first-timer just getting started in the world of Opensource, Git & Github, you will benefit from following the instructions and exercises given here: https://github.com/firstcontributions/first-contributions and then come back to this project.
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.
- 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
These instructions will create a Docker container with the required stack for running and developing the project. If you have Node v14 or higher installed already, and are working on the front end, you can run the front-end locally without preparing at Docker container by following the steps in section 4.
Copy the .env.example file to create your own local .env file.
cp .env.example .envUpdate any relevant keys in your new .env file. For example, if you will be working on functionality that requires logging in, create a free Auth0 account here and enter the relevant credentials from your account in your local .env file.
Please note: Any time you change the values in this .env file, you will need to stop and restart your Docker container in order for the new values to take effect.
- Click https://docs.docker.com/compose/install/, to start to install Docker Compose
- Click Get Docker Desktop for Mac under Install Compose on macOS
- Click Download from Docker Hub
- Click Get Docker to download docker and run Docker.dmg
- Install docker compose using PIP in command line: pip install -U docker-compose
- Run docker-image to start instance:
docker-compose -f "docker-compose.yml" up -d --buildIf this command doesn't work, run
PORT=9119 docker-compose upTypescript 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.
In order to run the client locally in development mode you must already have Node v14+ installed.
Create a local .env file if you have not already.
cp .env.example .envAdd relevant keys to your local .env file. For example, if you will be working on functionality that requires logging in, create a free Auth0 account here and enter the relevant credentials from your account in your local .env file.
Please note: any time one of the values in this .env file changes, you will need to stop (ctrl-c) and restart the development server in order for the changes to take effect.
Install dependencies.
npm iIf you run into errors with deprecated dependencies or dependency tree errors, try running yarn install instead. Once dependencies have successfully installed, start the development server.
npm startIf you want to watch the build run compiler-
./node_modules/.bin/tsc -p tsconfig.json --watchIf you want more help on running the app using npm then type-
npm --helpor 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.
Please read CONTRIBUTING.md before you help us!
(IN NO SPECIFIC ORDER)