aboutsummaryrefslogtreecommitdiffhomepage
path: root/CLAUDE.md
blob: 4c14a581a91092c254a8a4d65745ef22194b04fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# CLAUDE.md

## Project Overview

Feedaka is a personal RSS/Atom feed reader. Monorepo with a Go backend and React/TypeScript frontend, communicating via GraphQL.

## Tech Stack

- **Backend:** Go 1.24+, Echo v4, gqlgen (GraphQL), SQLite with sqlc
- **Frontend:** React 19, TypeScript, Vite, Tailwind CSS, urql (GraphQL client), wouter (routing)
- **Task Runner:** [just](https://github.com/casey/just) (justfiles at root and `backend/`)
- **Linting/Formatting:** Biome (frontend), go fmt (backend)
- **Code Generation:** gqlgen + sqlc (backend), graphql-codegen (frontend)

## Common Commands

### Build & Dev

```sh
just build       # Build both frontend and backend
just dev         # Start dev servers (frontend + backend)
just fmt         # Format all code
just check       # Type-check all code
just generate    # Regenerate GraphQL and DB code
```

### Frontend (run from `frontend/`)

```sh
npm run build    # Build with TypeScript + Vite
npm run dev      # Start Vite dev server
npm run check    # Run Biome checks
npm run fix      # Auto-fix with Biome
npm run generate # Generate GraphQL types
```

### Backend (run from `backend/`)

```sh
just build       # Compile Go binary
just fmt         # go fmt
just check       # Verify build compiles
just generate    # Run go generate (gqlgen + sqlc)
```

## Code Generation

Generated files — do not edit by hand:

- `backend/graphql/generated.go` — gqlgen output
- `backend/graphql/model/generated.go` — gqlgen models
- `backend/db/users.sql.go`, `backend/db/articles.sql.go`, `backend/db/feeds.sql.go` — sqlc output
- `frontend/src/graphql/generated/` — graphql-codegen output

Regenerate with `just generate` from the repo root.

## Project Structure

```
graphql/schema.graphql    # Shared GraphQL schema (source of truth)
backend/
  cmd/                    # CLI commands (serve, migrate, create-user)
  db/                     # Database layer, migrations, sqlc queries
  graphql/resolver/       # GraphQL resolvers (edit these for backend logic)
  feed/                   # Feed fetching logic
  auth/                   # Authentication
  config/                 # Configuration
  gqlgen.yml              # gqlgen config
  sqlc.yaml               # sqlc config
frontend/
  src/
    components/           # React components
    pages/                # Page components
    contexts/             # React contexts (auth)
    graphql/              # GraphQL queries/mutations
    services/             # GraphQL client setup
  biome.json              # Biome config
```

## CI

CI (`just check`, `just build`, `just fmt`) runs on pushes and PRs to main. Formatting changes must be committed before pushing — CI fails if `just fmt` produces uncommitted changes.