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

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

1. Install NX, our monorepo management framework.

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

3. 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