monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2025-03-10 13:44:27 +08:00
Code Issues Projects Releases Packages Wiki Activity

Updated CONTRIBUTING.md ()

Browse source 
* Renamed command line setting timer-progress bar

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Fixed wrong keyboard shortcut for mac
This commit is contained in:
UnrealApex 2021-06-29 07:59:46 -07:00 committed by GitHub
parent 74668f3d8b
commit 22b29aeea7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions

6
CONTRIBUTING.md
View file

@ -49,14 +49,16 @@
- Select default location and enable
## Building and Running
<!-- https://en.wikipedia.org/wiki/Control-C#:~:text=In%20many%20command,to%20the%20user. -->
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. It will watch for changes and rebuild when you edit files in `src/` or `public/`. Use ctrl+c to stop it.
- Run `firebase use <your-project-id>` if you run into any errors for this.
1. 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/` directories. Use <kbd>control c</kbd> to abort it.
- Run `firebase use {your-project-id}` if you run into any errors for this.
## Standards and Conventions
1. Code style is enforced by [Prettier](https://prettier.io/docs/en/install.html), which is automatically ran every time you `git commit` (if you've followed the above instructions properly).
1. If you are unsure of the best practices and conventions of Javascript, please take a look at the [JavaScript Best Practices](https://www.w3schools.com/js/js_best_practices.asp) and [JavaScript Coding Conventions](https://www.w3schools.com/js/js_conventions.asp)
## Questions