Leahnaya/smash-or-pass
1
0
Fork 0
mirror of https://github.com/Leahnaya/smash-or-pass.git synced 2026-03-21 22:14:07 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: setup README

Browse Source
This commit is contained in:
Alexandra 2022-02-14 23:54:58 +01:00
parent bce2e4f5ad
commit 42d05ab7ab
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -0,0 +1,29 @@
# smash-or-pass
Simple Smash or pass created with React.
Available with Pokemon list for now.
### Environment Variables
If you want to change environment variables, you just have to modify the config file found in `public/env/Config.js`
### Husky
if you want to enable a pre-commit hook for `prettier` and `eslint` with `husky`, run the following commands
```bash
$ cd projectRoot
$ npx husky install
```
To run the react app locally using npm, run the following commands
```bash
$ cd projectRoot
$ npm install
$ npm start
$ npx json-server --watch db.json --port 8080
```