monkeytype/README.md

# about
Monkey-type is a minimalistic, customisable typing test, featuring many test modes, an account system to save your typing speed history and user configurable features like themes, a smooth caret and more.

# features
- minimalistic design with no ads
- look at what you are typing
- focus mode
- different test modes
- punctuation mode
- themes
- live wpm
- smooth caret
- account system
- command line
- and much more

# discord bot
Recently, a Discord bot was added to autoassign roles. You can find the code for it over at https://github.com/Miodec/monkey-bot

# bug report or feature request
If you encounter a bug, or have a feature request - send me a message on Reddit, create an issue or join the [Discord server](https://discord.com/invite/yENzqcB).

# credits 
Montydrei for the name suggestion
Everyone who provided valuable feedback on the original reddit post for the prototype of this website
Contributors that have helped with implementing various features, adding themes and more.

# support
If you wish to support further development and feeling extra awesome, you can do so [here](https://www.paypal.me/jackbartnik).

# how to contribute
1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it.
2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project.
3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created.
4. Make sure you use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension.
5. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it.
6. Make sure to install `Prettier`. Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code.

That should be it. If you run into any problems, let me know.
readme update 2020-05-15 02:03:05 +08:00			`# about`
updated readme 2020-06-28 07:17:29 +08:00			`Monkey-type is a minimalistic, customisable typing test, featuring many test modes, an account system to save your typing speed history and user configurable features like themes, a smooth caret and more.`
readme update 2020-05-15 02:03:05 +08:00
Update README.md 2020-05-15 21:45:44 +08:00			`# features`
			`- minimalistic design with no ads`
			`- look at what you are typing`
			`- focus mode`
			`- different test modes`
			`- punctuation mode`
			`- themes`
			`- live wpm`
			`- smooth caret`
			`- account system`
			`- command line`
updated readme 2020-06-28 07:17:29 +08:00			`- and much more`
Update README.md 2020-05-15 21:45:44 +08:00
Update README.md 2020-07-08 04:15:48 +08:00			`# discord bot`
			`Recently, a Discord bot was added to autoassign roles. You can find the code for it over at https://github.com/Miodec/monkey-bot`

readme update 2020-05-15 02:03:05 +08:00			`# bug report or feature request`
Update README.md 2020-07-13 21:32:07 +08:00			`If you encounter a bug, or have a feature request - send me a message on Reddit, create an issue or join the [Discord server](https://discord.com/invite/yENzqcB).`
readme update 2020-05-15 02:03:05 +08:00
			`# credits`
Update README.md 2020-07-13 21:32:07 +08:00			`Montydrei for the name suggestion`
			`Everyone who provided valuable feedback on the original reddit post for the prototype of this website`
			`Contributors that have helped with implementing various features, adding themes and more.`
added support links to readme and about 2020-05-15 02:07:07 +08:00
			`# support`
Update README.md 2020-05-15 21:45:44 +08:00			`If you wish to support further development and feeling extra awesome, you can do so [here](https://www.paypal.me/jackbartnik).`
Updated readme to include a guide on how to contribute 2020-05-19 06:15:46 +08:00
typo 2020-06-05 00:33:26 +08:00			`# how to contribute`
Updated readme to include a guide on how to contribute 2020-05-19 06:15:46 +08:00			1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it.
updated readme 2020-06-28 07:16:00 +08:00			2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project.
Update README.md 2020-07-13 21:29:54 +08:00			3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created.
updated readme 2020-06-28 07:16:00 +08:00			4. Make sure you use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension.
Update README.md 2020-07-13 21:29:54 +08:00			5. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it.
Update README.md 2020-07-03 08:44:06 +08:00			6. Make sure to install `Prettier`. Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code.
Updated readme to include a guide on how to contribute 2020-05-19 06:15:46 +08:00
			`That should be it. If you run into any problems, let me know.`