Skip to content

Commit 1380005

Browse files
committed
docs: update README with authentication, fix frontend imports
- Add authentication section to README - Remove 'no auth' from limitations - Mark auth as complete in roadmap - Fix missing Activity/Database imports in page.tsx - Remove test_abes.db from tracking
1 parent 9901c35 commit 1380005

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,16 +314,54 @@ All 638 tests passing. Here's what was fixed and added:
314314
11. **Configurable Embedding Model**
315315
- `EMBEDDING_MODEL` env var (default: all-MiniLM-L6-v2)
316316

317+
12. **User Authentication**
318+
- JWT-based login/register system
319+
- SQLite persistence for user accounts
320+
- Protected routes requiring authentication
321+
- Beliefs associated with user accounts
322+
317323
### Remaining Known Issues
318324

319325
- Contradiction detection uses embeddings and antonym lists, not full semantic understanding
320326

321327
---
322328

329+
## Authentication
330+
331+
ABES includes a complete user authentication system:
332+
333+
### Endpoints
334+
335+
| Endpoint | Method | Description |
336+
|----------|--------|-------------|
337+
| `/auth/register` | POST | Create new account |
338+
| `/auth/login` | POST | Login, returns JWT token |
339+
| `/auth/me` | GET | Get current user (requires token) |
340+
| `/auth/logout` | POST | Logout (client discards token) |
341+
342+
### How It Works
343+
344+
1. Register with email, name, password (min 6 chars)
345+
2. Login to receive JWT token
346+
3. Include token in `Authorization: Bearer <token>` header
347+
4. Beliefs are associated with your user ID
348+
349+
### Frontend
350+
351+
The Next.js frontend handles auth automatically:
352+
- Redirects to `/login` if not authenticated
353+
- Stores token in localStorage
354+
- Shows user name and logout button in header
355+
356+
### User Data Storage
357+
358+
User accounts are stored in `data/users.db` (SQLite). This file is in `.gitignore` and will never be committed.
359+
360+
---
361+
323362
## Limitations
324363

325364
- Contradiction detection uses embeddings and antonym lists, not full semantic understanding
326-
- No authentication (session isolation is available but no user auth)
327365

328366
---
329367

@@ -335,7 +373,6 @@ Not yet implemented:
335373
- [ ] Document ingestion service
336374
- [ ] Full semantic contradiction detection (LLM-based)
337375
- [ ] Benchmarks against production memory systems
338-
- [ ] Authentication and user management
339376

340377
---
341378

data/test_abes.db

-32 KB
Binary file not shown.

frontend/app/page.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
import { fetchStats, Stats } from '@/lib/api';
55
import { useAuth } from '@/lib/auth';
66
import {
7+
Activity,
78
Brain,
89
ChevronRight,
10+
Database,
911
FileText,
1012
GitBranch,
1113
LogOut,

0 commit comments

Comments
 (0)