Max/zkldi_Tachi
1
0
Fork 0
mirror of https://github.com/zkldi/Tachi.git synced 2026-10-14 01:59:05 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme to point to new setup docs

Browse Source
This commit is contained in:
zkldi
2022-08-16 23:12:27 +01:00
parent 910a75a216
commit beefb18da0
1 changed files with 2 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -10
View File
@@ -19,17 +19,9 @@ There are way more features that Tachi has, and you can read about all of them [
## 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.
Check the [Documentation](https://docs-staging.bokutachi.xyz/contributing/setup) for how to set Tachi up.
You'll need `pnpm`. Get it with `npm install -g pnpm`.
Run `_scripts/bootstrap.sh` to set everything up. This script *must* be ran on a unix system.
The above script will move config files into active places, self-sign HTTPS Certificates for local development, install dependencies, start mongoDB and redis, and synchronise the database with the seeds.
After bootstrapping, you can use `pnpm start-server` and `pnpm start-client` to run the `server/` and `client/`.
Run both, together, to have a full tachi setup.
You can then check the component-specific guides to see how to run those components and contribute back.
## Repository Info