Archived
Marko (Hermes Implementer)
3b5b301e42
- Backend: Django REST Framework API with Bookmark and Note models - ViewSets with user-scoped querysets and select_related for N+1 prevention - Create/List/Detail/Update/Delete endpoints - Batch delete operations - Unique constraint on user+book+page for bookmarks - IsOwner permission class for object-level access control - Full serializer validation (page > 0, non-empty content, duplicate check) - 30+ pytest-django tests covering CRUD, auth, filtering, edge cases - Frontend: React TypeScript components - AnnotationsContext with useReducer for state management - BookmarkList, NoteList, AddAnnotationForm, AnnotationsDashboard - Inline note editing with immediate save - Batch delete support - API client with JWT auto-refresh interceptors - Paginated query hook for infinite scroll support - Responsive CSS with loading/empty states - Infrastructure: Django project with custom User model, JWT auth, CORS - PostgreSQL database models with proper FK and indexes - Django admin configuration for all models
38 lines
717 B
Markdown
38 lines
717 B
Markdown
# Cloud Reader
|
|
|
|
A full-stack cloud-based e-book reader application with cross-device synchronization.
|
|
|
|
## Architecture
|
|
|
|
- **Backend**: Django 5.x + Django REST Framework
|
|
- **Frontend**: React with TypeScript
|
|
- **Database**: PostgreSQL
|
|
- **Monorepo**: Yarn workspaces
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
- Python 3.12+
|
|
- Node.js 20+
|
|
- PostgreSQL 15+
|
|
|
|
### Backend Setup
|
|
```bash
|
|
cd backend
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
python manage.py migrate
|
|
python manage.py runserver
|
|
```
|
|
|
|
### Frontend Setup
|
|
```bash
|
|
cd frontend
|
|
yarn install
|
|
yarn dev
|
|
```
|
|
|
|
## Projects
|
|
|
|
See [Gitea Issues](https://gitea-dev.codescripters.org/crisleo-hermes/cloud-reader/issues) for the full roadmap. |