.github/README.md at main · bretton.dev/coves-frontend

Coves frontend - a photon fork

coves-frontend / .github / README.md

at main 27 lines 857 B view raw view rendered

wrap content

 1# Kelp
 2
 3Kelp is the web frontend for [Coves](https://coves.social), a forum-like social platform built on the AT Protocol.
 4
 5Originally forked from [Photon](https://github.com/Xyphyn/photon) by Xylight (AGPL-3.0).
 6
 7## Development
 8
 9```bash
10pnpm install
11pnpm dev          # Start dev server
12pnpm build        # Production build
13pnpm check        # TypeScript + Svelte type checking
14pnpm lint         # ESLint
15pnpm test         # Vitest
16```
17
18## Configuration
19
20- `PUBLIC_INSTANCE_URL` `string`: The domain which the browser will send API requests to.
21- `PUBLIC_SSR_ENABLED` `boolean`: Enable server-side rendering for SEO and non-JS usage.
22- `PUBLIC_INTERNAL_INSTANCE` `string`: The domain the server uses for API requests (only relevant with SSR).
23- `PUBLIC_THEME` `JSON`: A default theme for users, exported from the theme settings.
24
25## License
26
27AGPL-3.0-only