From b0a562ff4d8bc7434c09a9d27dbf52efa3843124 Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Sat, 16 Jul 2022 16:37:50 +0100 Subject: [PATCH] docs: document getting a local instance running --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index a91177494..7f326dbee 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,22 @@ By using Tachi, you get access to powerful, novel rhythm game score-tracking fea There are way more features that Tachi has, and you can read about all of them [here](https://tachi.readthedocs.io/user/features). +## Setup + +Setting up a local instance of Tachi at the moment is a bit of a pain. You'll need MongoDB and Redis installed and running. + +You'll need `pnpm`. Get it with `npm install -g pnpm`. + +Run `_scripts/bootstrap.sh` to move example config files into an active position. + +Use `pnpm install` to install all of the necessary dependencies. + +Use `pnpm start` in a directory to build and run the `client/` or `server/`. + +Run both, together, to have a full tachi setup. + +Use `ts-node server/src/scripts/sync-database` to load the database-seeds. + ## Repository Info This monorepo contains the following codebases: