yoginth.com
Hey is a decentralized and permissionless social media app built with Lens Protocol 🌿
chore: add spacing for improved readability in AGENTS.md
+6
+6
AGENTS.md
+6
AGENTS.md
···
1
1
# Repository Guidelines
2
2
3
3
## Project Structure & Modules
4
+
4
5
- `apps/web`: Vite + React 19 frontend (sources under `src/`, static assets in `public/`).
5
6
- `apps/api`: Hono-based API server (entry `src/index.ts`, routes in `src/routes/`).
6
7
- `packages/*`: Shared code (`helpers`, `data`, `types`, `indexer`, `config`).
···
8
9
- Tooling: PNPM workspaces (`pnpm-workspace.yaml`), Biome config (`biome.json`), Husky hooks (`.husky/`).
9
10
10
11
## Build, Test, and Development
12
+
11
13
- Root dev: `pnpm dev` — run all workspaces in watch mode.
12
14
- Root build: `pnpm build` — build all workspaces in parallel.
13
15
- Web app: `pnpm -F @hey/web dev` (preview: `pnpm -F @hey/web start`, build: `pnpm -F @hey/web build`).
···
17
19
- Node & PM: Node 20 (`.nvmrc`), PNPM 10 (see `package.json#packageManager`).
18
20
19
21
## Coding Style & Naming
22
+
20
23
- Language: TypeScript (strict, shared configs in `packages/config`).
21
24
- Formatting: Biome controls style; no trailing commas; spaces for indentation.
22
25
- Imports: Use workspace packages (`@hey/*`) and web alias `@/*` to `apps/web/src`.
···
24
27
- Keep modules small, colocate domain helpers with their feature when practical.
25
28
26
29
## Testing Guidelines
30
+
27
31
- Current status: no formal unit tests present. Enforce quality via `biome` and `tsc`.
28
32
- If adding tests, prefer Vitest for web and lightweight integration tests for API.
29
33
- Naming: `*.test.ts` or `*.test.tsx`, colocated with the code or under `__tests__/`.
30
34
- Run with a future `pnpm test` script at root or per package.
31
35
32
36
## Commit & Pull Requests
37
+
33
38
- Commits: imperative mood, concise subject; optional scope like `web:`, `api:`, `helpers:`.
34
39
- Include rationale and references (e.g., `Closes #123`).
35
40
- PRs: clear description, screenshots for UI changes, reproduction steps for fixes, and env notes.
36
41
- CI hooks: pre-commit runs `biome` and type checks; ensure both pass locally before pushing.
37
42
38
43
## Security & Configuration
44
+
39
45
- Copy `.env.example` to `.env` in `apps/web` and `apps/api`. Never commit secrets.
40
46
- Validate envs at startup; keep keys minimal and documented near usage.