Reading Progress
This commit is contained in:
13
README.md
13
README.md
@@ -131,9 +131,12 @@ cd backend
|
||||
### 🎨 **User Experience**
|
||||
- **Dark/Light Mode**: Automatic theme switching with system preference detection
|
||||
- **Responsive Design**: Optimized for desktop, tablet, and mobile
|
||||
- **Reading Mode**: Distraction-free reading interface
|
||||
- **Reading Mode**: Distraction-free reading interface with real-time progress tracking
|
||||
- **Reading Position Memory**: Character-based position tracking with smooth auto-scroll restoration
|
||||
- **Smart Tag Filtering**: Dynamic tag filters with live story counts in library view
|
||||
- **Keyboard Navigation**: Full keyboard accessibility
|
||||
- **Rich Text Editor**: Visual and source editing modes for story content
|
||||
- **Progress Indicators**: Visual reading progress bars and completion tracking
|
||||
|
||||
### 🔒 **Security & Administration**
|
||||
- **JWT Authentication**: Secure token-based authentication
|
||||
@@ -170,9 +173,9 @@ StoryCove uses a PostgreSQL database with the following core entities:
|
||||
|
||||
### **Stories**
|
||||
- **Primary Key**: UUID
|
||||
- **Fields**: title, summary, description, content_html, content_plain, source_url, word_count, rating, volume, cover_path
|
||||
- **Fields**: title, summary, description, content_html, content_plain, source_url, word_count, rating, volume, cover_path, reading_position, last_read_at
|
||||
- **Relationships**: Many-to-One with Author, Many-to-One with Series, Many-to-Many with Tags
|
||||
- **Features**: Automatic word count calculation, HTML sanitization, plain text extraction
|
||||
- **Features**: Automatic word count calculation, HTML sanitization, plain text extraction, reading progress tracking
|
||||
|
||||
### **Authors**
|
||||
- **Primary Key**: UUID
|
||||
@@ -214,7 +217,8 @@ StoryCove uses a PostgreSQL database with the following core entities:
|
||||
- `POST /{id}/rating` - Set story rating
|
||||
- `POST /{id}/tags/{tagId}` - Add tag to story
|
||||
- `DELETE /{id}/tags/{tagId}` - Remove tag from story
|
||||
- `GET /search` - Search stories (Typesense)
|
||||
- `POST /{id}/reading-progress` - Update reading position
|
||||
- `GET /search` - Search stories (Typesense with faceting)
|
||||
- `GET /search/suggestions` - Get search suggestions
|
||||
- `GET /author/{authorId}` - Stories by author
|
||||
- `GET /series/{seriesId}` - Stories in series
|
||||
@@ -295,6 +299,7 @@ All API endpoints use JSON format with proper HTTP status codes:
|
||||
- **Backend**: Spring Boot 3, Java 21, PostgreSQL, Typesense
|
||||
- **Infrastructure**: Docker, Docker Compose, Nginx
|
||||
- **Security**: JWT authentication, HTML sanitization, CORS
|
||||
- **Search**: Typesense with faceting and full-text search capabilities
|
||||
|
||||
### **Local Development Setup**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user