2020-09-15 22:28:15 +08:00
# Contributing
2020-09-15 21:53:17 +08:00
2020-09-15 22:28:15 +08:00
## Project Setup
2020-09-15 22:01:36 +08:00
2020-09-15 22:30:32 +08:00
1. [Create a new Firebase project. ](https://console.firebase.google.com/u/0/ )
2020-09-15 22:01:36 +08:00
2020-09-15 22:28:15 +08:00
- The project name doesn't really matter, but just name it `monkey-type` .
2020-09-15 22:30:32 +08:00
- Google Analytics is not necessary.
2020-09-15 22:01:36 +08:00
2020-09-15 22:28:15 +08:00
2. [Install the Firebase CLI ](https://firebase.google.com/docs/cli )
2020-09-15 22:30:32 +08:00
3. Run `firebase login` on your terminal to log in to the same google account as you just used to create the project.
4. Git clone this project.
2020-09-15 22:28:15 +08:00
5. Rename `.firebaserc_example` to `.firebaserc` and change the project name of default to the firebase project id you just created.
2020-09-15 22:01:36 +08:00
2020-09-15 22:28:15 +08:00
- If `.firebaserc_example` does not exist after cloning, create your own with:
2020-09-15 21:53:17 +08:00
2020-09-15 22:28:15 +08:00
```.firebaserc
{
"projects": {
"default": "your-firebase-project-id",
}
}
```
- Run `firebase projects:list` to find your firebase project id.
6. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it.
- Run `firebase use default` if you run into any errors for this.
## Standards & Conventions
2020-09-15 21:53:17 +08:00
1. Use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension.
2. Install [Prettier ](https://prettier.io/docs/en/install.html ). Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code.
2020-09-15 22:28:15 +08:00
## Questions
2020-09-15 22:30:32 +08:00
If you run into any problems, let [me ](https://github.com/Miodec ) know.
