DEPRECATED

This repo is inactive and not being monitored for security and functionality updates.

Develop locally

1. For Mac users, use homebrew to install yarn.
2. Run yarn run use-test-config.
3. Run yarn start.
4. Visit http://localhost:3000/ to view local app.
5. Look at package.json scripts section for the other commands you can run, e.g. yarn build.
6. Get familiar with Firebase, React, and Typescript. Take a look at the Create React App Guide - VS Code Debugging is nice. If using VS Code, recommended plugins include Firebase, Debugger for Chrome, and both Prettier and TSLint to automatically fix your style.
7. It is also helpful to install in your browser the React and Redux devtools extensions, to make it easier to inspect what's going on while you're making changes to the app.
8. Look at AppRouter.js for all of the main pages, visit/click around, and assign yourself an issue!
9. To test locally install watchman using brew install watchman and run yarn test.
10. After logging in to the test db for the first time, you will be taken to http://localhost:3000/invite-missing because your authentication uid is different. To fix this see edit your test uid.

Deploy

1. yarn deploy-test and play around, making sure that everything works there.
2. yarn deploy-prod

Firebase Rules

1. firebase deploy --project <project-id> --only firestore:rules

Troubleshooting

1. If you run into errors installing node modules, you may have to downgrade your version of Node. The latest LTS version (8.1) seems to work well.

Contributing

We welcome outside contributions! We try to label issues that are fairly isolated with good first issue. If you are looking for guidance, please comment on or create an issue.

Before opening a pull request please read and sign the Contributor License Agreement to protect you and us.