60 lines
1.2 KiB
Markdown
60 lines
1.2 KiB
Markdown
# StoryCove
|
|
|
|
A self-hosted web application for storing, organizing, and reading short stories from various internet sources.
|
|
|
|
## Quick Start
|
|
|
|
1. Copy environment variables:
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
2. Edit `.env` with secure values for all variables
|
|
|
|
3. Start the application:
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
4. Access the application at http://localhost
|
|
|
|
## Architecture
|
|
|
|
- **Frontend**: Next.js (Port 3000)
|
|
- **Backend**: Spring Boot (Port 8080)
|
|
- **Database**: PostgreSQL (Port 5432)
|
|
- **Search**: Typesense (Port 8108)
|
|
- **Proxy**: Nginx (Port 80)
|
|
|
|
## Development
|
|
|
|
### Frontend Development
|
|
```bash
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
### Backend Development
|
|
```bash
|
|
cd backend
|
|
./mvnw spring-boot:run
|
|
```
|
|
|
|
### Commands
|
|
- `docker-compose up -d` - Start all services
|
|
- `docker-compose down` - Stop all services
|
|
- `docker-compose logs -f [service]` - View logs
|
|
- `docker-compose build` - Rebuild containers
|
|
|
|
## Features
|
|
|
|
- Story management with HTML content support
|
|
- Author profiles with ratings and metadata
|
|
- Tag-based categorization
|
|
- Full-text search capabilities
|
|
- Responsive reading interface
|
|
- JWT-based authentication
|
|
- Docker-based deployment
|
|
|
|
For detailed specifications, see `storycove-spec.md`. |