Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Local setup.md for tldraw #35

Merged
merged 3 commits into from
Jun 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/services/tldraw/Local setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@

### To run tldraw locally:

1. Run all of the apps needed for schulcloud like mongodb, backend, frontend, file storage etc.
2. Run redis i.e. in a docker container, it will work on localhost:6379 by default which is what the REDIS_URI env var is set to
3. On schulcloud-server repo: npm run nest:start:tldraw:dev
4. On tldraw-client repo: npm run dev
1. Run redis i.e. in a docker container, it will work on localhost:6379 by default which is what the REDIS_URI env var is set to, for example on wsl: https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/
2. Add to server repo the .env with following values
Please note redis default user is use and you can pass random value as password like the 123.
REDIS_URI=redis://default:[email protected]:6379
TLDRAW_ADMIN_API_CLIENT__API_KEY=randomString
ADMIN_API__ALLOWED_API_KEYS=randomString
TLDRAW_ADMIN_API_CLIENT__BASE_URL=http://localhost:3349
3. To run
1. npm run nest:start:dev (schulcloud-server)
2. npm run nest:start:files-storage:dev (schulcloud-server with s3, if you want to upload files)
3. npm run nest:start:tldraw:dev (schulcloud-server)
4. npm run dev (schulcloud-client)
5. npm run servce (nuxt-client)
6. npm run dev (tldraw-client)

### Create new whiteboard:

Expand Down
Loading