From 07cb5fa92b7f9f4bc028aa4e7dde5f6192c3842c Mon Sep 17 00:00:00 2001 From: Tijmen van der Kemp Date: Tue, 10 Jun 2025 10:52:50 +0200 Subject: [PATCH 1/3] Update README with troubleshooting tips during installation of the project --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56392808b3c..40312cc5cb8 100644 --- a/README.md +++ b/README.md @@ -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. From bca95d42f8dbc095477ed7c6070b9d1d607173ac Mon Sep 17 00:00:00 2001 From: Tijmen van der Kemp Date: Tue, 10 Jun 2025 11:08:57 +0200 Subject: [PATCH 2/3] Update README with more troubleshooting --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 40312cc5cb8..b6632110b49 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ 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` +1. **Clone** the repo and in the root directory run `npm install` - *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` @@ -26,6 +26,10 @@ Troubleshooting: - 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'. +- *I ran `npm run start:dev` but it didn't seem to start anything* + - If the last message before your command was `lefthook something something post-merge`, your `run` command got eaten by the Lefthook monster, but running it again will work. +- *I started the game but all text looks like code instead of actual sentences* + - You likely downloaded the code instead of cloning the repository, meaning that the localization submodule did not get included. Can you start again and clone the repository instead of downloading the code as a ZIP file? #### Linting From 8dc9af31f0b259a5e15e8209e8b1c64245350d11 Mon Sep 17 00:00:00 2001 From: Tijmen van der Kemp Date: Tue, 10 Jun 2025 11:14:53 +0200 Subject: [PATCH 3/3] Remove quotes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b6632110b49..0f794f90bb6 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ 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'. + - You likely need to press Enter. - *I ran `npm run start:dev` but it didn't seem to start anything* - If the last message before your command was `lefthook something something post-merge`, your `run` command got eaten by the Lefthook monster, but running it again will work. - *I started the game but all text looks like code instead of actual sentences*