Environment Setup and NPM Script Commands

• Install NodeJS and either NPM or Yarn
• Use NPM or Yarn to install all packages
• Create a .env file at the project root following .env.sample
• Build via npm run build
• Start Client via npm run start
• Start Backend via npm run start:server
• Deploy to Firebase via build:deploy
• Tests run via npm run test
• Tests with coverage via npm run test:coverage
• Prettier is ran with the deploy script or you can run via npm run prettier

Contributions

These are some Contribution Guidelines for those working on the project. This is hosted publicly in GitHub, but isn't a library. Odds are no one will be interested in contributing other than a few developers who are a part of this idea.

• Make Pull Requests to the dev branch.
• Write tests for any new code. Be thorough.
• Make good decisions. If we can do that then there shouldn't be any problems.

About

This is a Web Application built using the ReactJS library. We wanted to get in some practice with ReactJS and also wanted to make an app that could be useful. More information about this Application may be available later.

Authors

• @dghalbr
• @neighbor983