mirror of
https://github.com/R0m1k3/FlowReader.git
synced 2026-10-22 22:58:06 +02:00
feat(story-1.1): implement walking skeleton with Go Chi and Docker Compose
This commit is contained in:
1 parent
d7ad2536d6
commit
99f1300e13
11 files changed
+411
No files matched your search
@@ -0,0 +1,56 @@
|
||||
# FlowReader
|
||||
|
||||
A minimalist, self-hosted RSS/Atom reader focused on simplicity and resource efficiency.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Start with Docker Compose
|
||||
docker-compose up --build
|
||||
|
||||
# Or use Make
|
||||
make docker-up
|
||||
```
|
||||
|
||||
Access the API: `http://localhost:8080`
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Run locally (requires Go 1.22+)
|
||||
make dev
|
||||
|
||||
# Run tests
|
||||
make test
|
||||
|
||||
# Lint code
|
||||
make lint
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
flowreader/
|
||||
├── cmd/
|
||||
│ └── server/ # Application entry point
|
||||
├── internal/
|
||||
│ ├── domain/ # Business logic (entities, services)
|
||||
│ ├── handler/ # HTTP handlers
|
||||
│ └── repository/ # Database access
|
||||
├── pkg/ # Shared utilities
|
||||
└── migrations/ # SQL migrations
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Backend**: Go 1.22+ (Chi Router, pgx driver)
|
||||
- **Database**: PostgreSQL 16+
|
||||
- **Frontend**: React + Vite (coming in Epic 3)
|
||||
|
||||
## Memory Target
|
||||
|
||||
Total container footprint: **< 150MB RAM**
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in new issue
Block a user