From a35d99fa843a9c4685db4a0c7d461167b390f1cb Mon Sep 17 00:00:00 2001 From: William Lam Date: Thu, 29 Aug 2024 17:26:04 -0400 Subject: [PATCH] Updated README.md for instructions to run locally (#1859) * Add trustedDependencies * Updated the "Running locally" section of README.md with the correct bin usage (bun) - Added installation step for the tsx bin & updated the installation doc URL (previous URL does not work anymore) * Fixed indentation in package.json again * Proper library name * Removed tsx install step in README * Re-ran bun install to update bun.lockb * Matched package.json to rewrite branch & re-ran bun install to update lock file --------- Co-authored-by: Kalle <38327916+Sendouc@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 63b544a52..7f68e1aed 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,11 @@ Prerequisites: [nvm](https://github.com/nvm-sh/nvm) There is a sequence of commands you need to run: 1. `nvm use` to switch to the correct Node version. If you don't have the correct Node.js version yet it will prompt you to install it via the `nvm install` command. If you have problems with nvm you can also install the latest LTS version of Node.js from [their website](https://nodejs.org/en/). -2. Install latest version of [npx tsx](https://npx tsx.sh/docs/installation) -3. `npx tsx install` to install the dependencies. +2. Install latest version of [Bun](https://bun.sh/docs/installation) +3. `bun install` to install the dependencies. 4. Make a copy of `.env.example` that's called `.env`. Filling additional values is not necessary unless you want to use real Discord authentication or develop the Lohi bot. -5. `npx tsx migrate up` to set up the database tables. -6. `npx tsx run dev` to run the project in development mode. +5. `bun migrate up` to set up the database tables. +6. `bun run dev` to run the project in development mode. 7. Navigate to `http://localhost:5173/admin`. There press the seed button to fill the DB with test data. You can also impersonate any user (Sendou#0043 = admin). ## Contributing