ayo/mnswpr
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
Ayo 2022-11-28 10:22:10 +01:00
parent fc74666d74
commit 2e8dc39b57
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -9,8 +9,6 @@ Stack:
- Firebase for leader board store
- Netlify for hosting
*❗️ __Warning:__ This is a very messy code; a product of quick hacking and shipping while live users are giving feedback*
## Project motivation
One day, while working in my home office, I heard loud and fast mouse clicks coming from our bedroom. It's my wife, playing her favorite game (Minesweeper) on a crappy website full of advertisements.
@ -38,12 +36,13 @@ To start development, you need node v16 (the dev server doesn't work on v18 *yet
1. Install dependencies: `npm i`
2. Start the dev server: `npm run dev`
*📝 __Note:__ There's no hot reloading. You have to reload the app after making a change. OR contribute to enable HMR? ;)*
## Running Locally
After running the commands to start development, open in a browser: `http://localhost:4200`
## Contribution reminders
1. There's no hot reloading. You have to reload the app after making a change. OR contribute to enable HMR? ;)
2. This is a very messy code; a product of quick hacking and shipping while live users are giving feedback. Let's clean it up!
## Live Demo
*👉 The live site is here: [Minesweeper](https://mnswpr.com)*