blob: b8f468d1833bc553ad844370d8db0e5e4e9c4f8f (
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
# Kioku
A spaced repetition learning application (Anki clone) with PWA offline support and cloud sync.
## Features
- Spaced Repetition: FSRS algorithm for optimal learning scheduling
- Offline Support: Full PWA with IndexedDB local storage
- Cloud Sync: Automatic sync when online with conflict resolution
- Anki Import: Import existing .apkg decks from Anki
## Development Setup
### Prerequisites
- Node.js 22+
- pnpm 10+
- Docker (for PostgreSQL)
### Setup
```bash
# Install dependencies
pnpm install
# Copy environment variables
cp .env.example .env
# Edit .env for local development:
# DATABASE_URL=postgresql://kioku:kioku@localhost:5432/kioku
# Start PostgreSQL
docker compose up db -d
# Run database migrations
docker compose exec server pnpm db:migrate
# Add a user
docker compose exec server pnpm user:add
# Start development servers (in separate terminals)
pnpm dev # Backend server (port 3000)
pnpm dev:client # Frontend dev server (port 5173)
```
### Environment Variables
| Variable | Description | Example |
|----------|-------------|---------|
| `POSTGRES_USER` | PostgreSQL username | `kioku` |
| `POSTGRES_PASSWORD` | PostgreSQL password | `kioku` |
| `POSTGRES_DB` | PostgreSQL database name | `kioku` |
| `DATABASE_URL` | Full PostgreSQL connection string | `postgresql://kioku:kioku@localhost:5432/kioku` |
| `JWT_SECRET` | Secret key for JWT tokens (use a secure random string in production) | `your-secret-key` |
## Scripts
| Command | Description |
|---------|-------------|
| `pnpm dev` | Start backend server in development |
| `pnpm dev:client` | Start frontend dev server |
| `pnpm build` | Build both server and client |
| `pnpm start` | Start production server |
| `pnpm test` | Run tests |
| `pnpm typecheck` | Run TypeScript type checking |
| `pnpm lint` | Lint code with Biome |
| `pnpm lint:fix` | Lint and auto-fix issues |
| `pnpm db:migrate` | Run database migrations |
| `pnpm db:studio` | Open Drizzle Studio (database GUI) |
| `pnpm user:add` | Add a new user (interactive) |
## Docker
### Services
- **db**: PostgreSQL 18 database
- **server**: Node.js backend (Hono)
- **client**: Nginx serving the React frontend
### Commands
```bash
# Start all services
docker compose up -d
# View logs
docker compose logs -f
# Connect database
docker compose exec db psql -U kioku
# Stop all services
docker compose down
# Rebuild after code changes
docker compose up -d --build
# Add a user in production
docker compose exec server pnpm user:add
```
## Documentation
- [Architecture](docs/dev/architecture.md) - System design and data models
- [Roadmap](docs/dev/roadmap.md) - Development phases and progress
## License
MIT
|
