Git Product home page Git Product logo

covid-alert's Introduction

OpenMined Web Monorepo

Welcome to the OpenMined web monorepo, the home of all of OpenMined's many websites. Below are some basic instructions for getting this repository running on your machine.

Support

If you're looking for support about the courses, please go the Courses Discussion Board. If you've found a bug, or have a suggestion for an improvement to the Courses site, or any of our websites, please file an issue here.

Contributing

We are currently only accepting bug fixes from our community at the moment. If you're interested in working on these sites regularly as part of a team, please DM @Patrick Cason on Slack with your resume and qualifications.

Local Setup

  1. Make sure that you have Node, NPM, and Yarn installed on your machine.

  2. Install NX, our monorepo management framework.

  3. From this point forward, you will run all commands in the root folder. Start by running yarn install to install all dependencies.

  4. Run one of the below commands, depending on what you're trying to do... note that the third word in the command corresponds to the app in question. For instance, yarn start courses will run the courses app, located at apps/courses.

Courses

The OpenMined Courses website where we host our educational material. The site is a React.js web application, running on a Firebase backend, Jest for testing, Cypress for end-to-end testing, and using Sanity.io as the content management system (CMS).

  • yarn start courses - Runs the courses site with hot reloading for development purposes.

  • yarn lint courses - Runs the linter for the courses site

  • yarn test courses - Runs the test suite for the courses site

  • yarn build courses - Builds the courses site

  • yarn build courses --prod - Builds a production version of the courses site

  • yarn analyze courses - Analyzes the file sizes and distribution of a built version of the courses site

Courses E2E Testing

The OpenMined Courses website uses Cypress for end-to-end-testing. You have access to the following commands:

  • yarn e2e courses-e2e - Runs all the end-to-end tests for the Courses website

  • yarn lint courses-e2e - Runs the linter for the courses end-to-end app

Firebase API

Firebase is the primary backend for all of OpenMined's websites. If you want to test any functions or security rules before pushing them live, you may do so using the emulator suite.

  • yarn test firebase-api - Runs all the tests for the our Firebase backend

Sanity CMS

Sanity is the primary CMS for all of OpenMined's websites. You must have a user account to change any actual values, however, if you want to run it on your machine, you have access to the following commands:

  • yarn start sanity-api - Runs the Sanity CMS with hot reloading for development purposes.

  • yarn lint sanity-api - Runs the linter for the Sanity CMS

  • yarn test sanity-api - Runs the test suite for the Sanity CMS

  • yarn build sanity-api - Builds the Sanity CMS

  • yarn build sanity-api --prod - Builds a production version of the Sanity CMS

  • yarn analyze sanity-api - Analyzes the file sizes and distribution of a built version of the Sanity CMS

covid-alert's People

Contributors

cereallarceny avatar iamtrask avatar kevmo314 avatar kritikalcoder avatar s0l0ist avatar samelsamel avatar tcp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

covid-alert's Issues

Translation to Korean

Hi Folks,

The COVID - ALERT app currently works in 8 different languages. We need this to work in Korean. We estimate the time needed for this task would be around 60-90 minutes. Please be very sensitive to the nature of messaging - best would be to slack me "Shreyas" and align on the tone and meaning before publishing it.

thanks

Add Google Maps location data import

We need to allow patients to import their Google Maps data as locations in the DB. This should help the process of inputting data to be much faster and far more accurate.

Translation to Japanese

Hi Folks,

The COVID - ALERT app currently works in 8 different languages. We need this to work in Japanese. We estimate the time needed for this task would be around 60-90 minutes. Please be very sensitive to the nature of messaging - best would be to slack me "Shreyas" and align on the tone and meaning before publishing it.

thanks

Quarantine reminders | Messaging

For the earlier issue on Quarantine reminder | Engine. We'd need a way to message the information in a safe, cheerful & accurate manner. We have some thoughts around it - would be good to work with a contributor bounce ideas & get this in the app.

I expect this not to take more than 60 minutes

Translation into Hindi

Hi Folks,

The COVID - ALERT app currently works in 8 different languages. We need this to work in Hindi. We estimate the time needed for this task would be around 60-90 minutes. Please be very sensitive to the nature of messaging - best would be to slack me "Shreyas" and align on the tone and meaning before publishing it.

thanks

Quarantine reminders | Design : Front end

For the already existing issue on (Quarantine reminders | Engine) we'd need a front end to show where the user lies against a population on a dashboard. Can we mock up a couple of front-end graphics/ designs that we could then go and build out

Store keypair

Persist the keypair on the React Native app so that we only need to generate that once.

Quarantine reminders | Engine : Calculating distance

Let's calculate the distance that the user moves everyday. Also, would be good to centralize this information somewhere so that we could show where they lie on the curve. Top 10% of all movers, Bottom 10% le of all movers etc.,

(Note: The location data works only if we have the "always on" permission on the app. This is the best we can do!)

Need better date and time inputs for dashboard

Currently, all of our dates and times are formatted as text inputs and receive little or no validation and formatting. We should have these inputs be smarter to prevent confusion and user error.

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.