mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-06-21 09:02:47 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README with troubleshooting tips during installation of the project

Browse Source
This commit is contained in:
Tijmen van der Kemp 2025-06-10 10:52:50 +02:00 committed by Tijmen van der Kemp
parent b1c50dd69f
commit 07cb5fa92b
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -18,9 +18,15 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
#### Running Locally
1. Clone the repo and in the root directory run `npm install`
- *if you run into any errors, reach out in the **#dev-corner** channel in discord*
- *if you run into any errors, check out Troubleshooting below and then reach out in the **#dev-corner** channel in discord*
2. Run `npm run start:dev` to locally run the project in `localhost:8000`
Troubleshooting:
- *fatal: not a git repository (or any of the parent directories): .git*
- Install git, and then run `git init` in the folder of the project.
- *Lefthook seems to be stuck running the post-merge check*
- You likely need to press 'Enter'.
#### Linting
We're using Biome as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run biome` script. To view the complete rules, check out the [biome.jsonc](./biome.jsonc) file.