Commit e48804fd authored Jul 10, 2025 by Grant

minor updates

parent d17d4dc5

README.md

+4 −0

Original line number	Diff line number	Diff line
		@@ -25,3 +25,7 @@ Canvas is a real-time collaborative pixel canvas
		## Special Thanks

		## What is sc07?

		## License

		Canvas is licened under the MIT license see `LICENSE`
		No newline at end of file

doc/contributing/getting-started.md

+3 −4

Original line number	Diff line number	Diff line
		@@ -30,10 +30,9 @@ The project is setup as a monorepo, with the frontend, backend and admin interfa
		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`
		4. Install all dependencies (`npm install --include=dev`)
		5. Start the server: `npm run dev:server`
		6. Start the client: `npm run dev:client` (Note on WSL: you may need to use `npm run dev:client -- -- --host` to get it loading)

		## Architecture

packages/server/.env.example

+2 −0

Original line number	Diff line number	Diff line
		@@ -20,6 +20,7 @@ LOG_LEVEL=debug
		PORT=3000

		SESSION_SECRET=SomeRandomTextHere
		CAPTCHA_HMAC_SECRET=SomeRandomTextHere

		# Prometheus authorization token for /metrics
		PROMETHEUS_TOKEN=token
		@@ -27,6 +28,7 @@ PROMETHEUS_TOKEN=token
		# Host for callback redirect
		# Default is the Vite default
		OIDC_CALLBACK_HOST=http://localhost:5173
		AUTH_MODE=TRUST
		# Fediverse-auth host
		AUTH_ENDPOINT=http://fedi-auth
		AUTH_CLIENT=client_id_here