monkeytype/CONTRIBUTING.md

Contributing

Technologies

• NodeJS v10
• Firebase

Prerequisite - Mongo setup

1. Install MongoDB: Community Edition
2. Optional: Install Mongodb Compass for easier viewing and manipulation of data

Building and Running

1. Run npm ci in the project root directory to install dependencies.
2. Run npm run start:dev to start a local dev server on port 5000. It will watch for changes and rebuild when you edit files in src/ or public/. Use ctrl+c to stop it.

Standards and Conventions

1. Code style is enforced by Prettier, which is automatically ran every time you git commit (if you've followed the above instructions properly).

Questions

If you run into any problems, let me know on GitHub or Discord in the #development channel.