mirror of
https://github.com/calibrain/shelfmark.git
synced 2026-09-30 22:06:48 +01:00
CaliBrain
b02ad7452c
This commit removes all references to the deprecated /request route prefix that was previously used for dual routing. The following changes were made: - Removed register_dual_routes() function that registered routes with /request prefix - Removed url_for_with_request() helper function for generating /request URLs - Removed call to register_dual_routes(app) at application startup - Removed /request/ prefixed favicon routes - Updated StatusEndpointFilter to remove /request/api/status log filtering - Removed unused flask_url_for import All routes now only use the standard paths without the /request prefix.
100 lines
2.3 KiB
Markdown
100 lines
2.3 KiB
Markdown
# Source Code Documentation
|
|
|
|
This directory contains the frontend application for Calibre-Web Automated Book Downloader.
|
|
|
|
## Structure
|
|
|
|
```
|
|
src/
|
|
└── frontend/ # React + TypeScript frontend application
|
|
├── public/ # Static assets (logo, favicon)
|
|
├── src/ # Source code
|
|
│ ├── components/ # React components
|
|
│ ├── App.tsx # Main application component
|
|
│ └── styles.css # Global styles
|
|
├── package.json # Dependencies and scripts
|
|
├── vite.config.ts # Vite configuration
|
|
└── tsconfig.json # TypeScript configuration
|
|
```
|
|
|
|
## Frontend Development
|
|
|
|
### Prerequisites
|
|
- Node.js (v16 or higher)
|
|
- npm or yarn
|
|
|
|
### Quick Start
|
|
|
|
From the project root:
|
|
```bash
|
|
# Install dependencies
|
|
make install
|
|
|
|
# Start development server (http://localhost:5173)
|
|
make dev
|
|
|
|
# Build for production
|
|
make build
|
|
|
|
# Preview production build
|
|
make preview
|
|
|
|
# Run type checking
|
|
make typecheck
|
|
```
|
|
|
|
Alternatively, from `src/frontend`:
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
npm run build
|
|
```
|
|
|
|
### Technology Stack
|
|
- **Framework**: React 18 with TypeScript
|
|
- **Build Tool**: Vite 5
|
|
- **Styling**: TailwindCSS 3
|
|
- **Communication**: WebSocket for real-time updates
|
|
|
|
### Key Features
|
|
- **Search Interface**: Real-time book search with filtering
|
|
- **Download Queue**: Live status updates via WebSocket
|
|
- **Details Modal**: Rich book information display
|
|
- **Responsive Design**: Mobile-first approach
|
|
|
|
## Development Tips
|
|
|
|
### Hot Module Replacement (HMR)
|
|
The development server supports HMR for instant feedback during development.
|
|
|
|
### API Integration
|
|
The frontend communicates with the Flask backend via:
|
|
- REST API endpoints (`/api/*`)
|
|
- WebSocket connection (`ws://localhost:8084/ws`)
|
|
|
|
### Building for Production
|
|
The production build is optimized and minified:
|
|
```bash
|
|
make build
|
|
```
|
|
Output is generated in `src/frontend/dist/`
|
|
|
|
### Type Safety
|
|
Run TypeScript checks without building:
|
|
```bash
|
|
make typecheck
|
|
```
|
|
|
|
## Debugging
|
|
|
|
### Development Server Issues
|
|
- Ensure port 5173 is available
|
|
- Check that the backend is running on port 8084
|
|
- Verify WebSocket connection in browser console
|
|
|
|
### Build Issues
|
|
- Clear `node_modules` and reinstall: `make clean && make install`
|
|
- Check Node.js version compatibility
|
|
- Verify TypeScript configuration
|
|
|