Skip to content

Latest commit

 

History

History
147 lines (95 loc) · 5.78 KB

README.md

File metadata and controls

147 lines (95 loc) · 5.78 KB
Raw

Contributors MIT License

COVID19 Hackathon by Nth Opinion

Calling All Doctors & Coders: Global Hackathon to Defeat COVID-19: Connecting physicians & developers globally in the wake of COVID-19 pandemic

Our application is a web app. It has a public facing interface, and a doctor/healthcare worker facing interface. Users can search through a database of previously asked questions about COVID-19 (or add their question to the database if it hasn't already been asked), and obtain answers from medical professionals around the globe.

Explore the website

Join our Slack

Request Feature

Report Issue

Table of Contents

About The Project

Calling All Doctors & Coders: Global Hackathon to Defeat COVID-19: Connecting physicians & developers globally in the wake of COVID-19 pandemic

Our application is a web app. It has a public facing interface, and a doctor/healthcare worker facing interface. Users can search through a database of previously asked questions about COVID-19 (or add their question to the database if it hasn't already been asked), and obtain answers from medical professionals around the globe.

https://www.covid19webapp.com/

Our realtime database will contain the most urgent questions and answers on COVID-19 and publish it to the world. With our app in the hands of front line workers who have or are already experiencing the first wave, they can share their knowledge and help the health care workers who will be hit next.

NOTICE: This open source project is a work in progress. The best way to get onboarded and brought up to speed is to participate in our Slack channel:

Join our Slack

Update March 15, 2020: Please excuse the bugs as we are working hard to fix them on the fly! COVID-19 is spreading faster than we can code and as a result converted the project to open source overnight. We understand there are bugs and the code is not optimized. Thank you for working with us as we adapt in real-time! Don’t be shy, reach out, and get involved.

Built With

Getting Started

The COVID19 project is a monorepo. The server code is inside the api foler and the client code is inside the client folder.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
npm install npm@latest -g

Installation

  1. Navigate to the repository where you want to install the project
  2. Clone the repo
git clone [email protected]:nthopinion/covid19.git
  1. To setup the api, check the README inside the api folder.
  2. To setup the client, check the README inside the client folder.

Tests

Testing is important in order to make sure you feature is meeting all the requirements. Launch the test runner in the interactive watch mode by running the npm command

npm test

Roadmap

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

Contributing

Contributions in this project are vital since the situation is evolving rapidly. Any contributions you make are greatly appreciated.

  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

If you are stuck on any of the steps, we have a YouTube video you can look at: https://youtu.be/otuDhXWWnbw

License

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

Communication channels

Come over on Slack to be part of the initiative and talk with the other contributors

Project Link: https://github.com/nthopinion/covid19/