monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2024-09-20 07:16:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated contributing to mention nodb development

Browse source
This commit is contained in:
Jack 2021-08-25 15:49:47 +01:00
parent 3df0230c70
commit 1c37cf9245
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -72,6 +72,8 @@ Git is optional but we _highly_ recommend you use it. Monkeytype uses the Git so
#### Mongo Setup
Follow these steps if you want to work on anything involving the database / account system. If not, you can skip this section.
1. Install [Mongodb Community Edition](https://docs.mongodb.com/manual/administration/install-community/) and ensure that it is running
1. Inside the backend folder, copy `example.env` to `.env` in the same directory.
@ -88,7 +90,7 @@ The installation process of NodeJS is fairly simple, navigate to the NodeJS [web
Once you have completed the above steps, you are ready to build and run Monkeytype.
1. Run `npm install` in the project root directory to install dependencies.
1. Run `npm run start:dev` to start a local dev server on [port 5000](http://localhost:5000). It will watch for changes and rebuild when you edit files in `src/` or `public/` directories. Note that rebuilding doesn't happen instantaneously so be patient for changes to appear. Use <kbd>Ctrl+C</kbd> to kill it.
1. Run `npm run start:dev` (`npm run start:dev:nodb` if you skipped the mongo section) to start a local dev server on [port 5000](http://localhost:5000). It will watch for changes and rebuild when you edit files in `src/` or `public/` directories. Note that rebuilding doesn't happen instantaneously so be patient for changes to appear. Use <kbd>Ctrl+C</kbd> to kill it.
### Standards and Guidelines