Commit 0e3dc8a5 authored by Grant's avatar Grant Committed by Grant
Browse files

clean up quick start

parent 08545061

doc/contributing/getting-started.md

+7 −7
Original line number Diff line number Diff line
@@ -27,13 +27,13 @@ The project is setup as a monorepo, with the frontend, backend and admin interfa 


## Quick start



1. `nvm use`

1. copy `packages/client/.env.example` to `packages/client/.env.local` and modify (if needed)

1. copy `packages/server/.env.example` to `packages/server/.env` and modify

1. ensure fediverse-auth is running

1. `npm install --include=dev`

1. `npm run dev:server`

1. `npm run dev:client`

1. Use the node version the project is built using (run `nvm use` in the root or view `/.nvmrc` for the version)

2. Copy `packages/client/.env.example` to `packages/client/.env.local` and modify

3. Copy `packages/server/.env.example` to `packages/server/.env.local` and modify

4. Start fediverse-auth

5. Install all dependencies (`npm install --include=dev`)

6. Start the server: `npm run dev:server`

7. Start the client: `npm run dev:client`



## Architecture