blob: eab12fc1e143958f22b077661f5cc77e05b50d7b (
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
|
# 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
## Getting Started
### Prerequisites
- Node.js 22+
- pnpm 10+
- PostgreSQL 18+
- Docker
- Direnv (optional)
### Development
```bash
# Install dependencies
pnpm install
# Start containers
docker compose up
# Run database migrations
pnpm db:migrate
# Start development server
pnpm dev
```
### Environment Variables
Create `.env` file in the root directory:
```
DATABASE_URL=postgresql://user:password@localhost:5432/kioku
JWT_SECRET=your-secret-key
```
## Scripts
```bash
pnpm dev # Start server in development
pnpm dev:client # Start client in development
pnpm build # Build all
pnpm test # Run tests
pnpm lint # Lint code
pnpm db:migrate # Run database migrations
pnpm db:studio # Open Drizzle Studio
```
## Documentation
See [docs/dev/architecture.md](docs/dev/architecture.md) for detailed architecture documentation.
## License
MIT
|
