Skip to content

Commit

Permalink
Updated README.md for instructions to run locally (#1859)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
ElementUser and Sendouc authored Aug 29, 2024
1 parent fb7b87d commit a35d99f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a35d99f

Please sign in to comment.