Giter VIP home page Giter VIP logo

mycovidconnect's Introduction

mycovidconnect1

TL;DR: Start Contributing right away:

Open in Gitpod

DepShield Badge

Open Source Helpers

Netlify Status

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



In general follow this Javascript Styleguide

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

3. Installation

Install Docker Compose on Mac

  • 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 --build

If this command doesn't work, run

PORT=9119 docker-compose up

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

jmakhack

odysseaspapadimas

mycovidconnect's People

Contributors

codecakes avatar nivedhasamy avatar premalrupnur avatar jasonwei1106 avatar rohini24 avatar ksr89 avatar geekysankar avatar andyderek avatar harindra2002 avatar jmakhack avatar batistadev1113 avatar odysseaspapadimas avatar vasynizami avatar shivarajloni avatar snyk-bot avatar daxiaokongyi avatar sumeetp4 avatar kemo-code avatar premiumdas avatar akshayparmar90 avatar mend-bolt-for-github[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.