refactor: restructure project from bookmann to shelf
- Rename project from 'bookmann' to 'shelf' - Move all backend/ contents to root level (flatten structure) - Update Go module name from 'bookmann' to 'shelf' - Update all import paths to use new 'shelf' module - Update Dockerfile to work without backend/ subdirectory - Update docker-compose.yml to use new structure and rename containers - Update .gitignore for new file paths - Update README.md with new project name and structure - Regenerate database code with new module imports
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# 📚 Bookmann
|
||||
# 📚 Shelf
|
||||
|
||||
A self-hosted ebook management system built with Go, PostgreSQL, HTMX, and Tailwind CSS (fully integrated into a single service) featuring multiple beautiful dark themes with Tokyo Night as default.
|
||||
A self-hosted ebook management system built with Go, PostgreSQL, HTMX, and Tailwind CSS featuring multiple beautiful dark themes with Tokyo Night as default. Smart folder scanning with real-time monitoring and rich EPUB metadata extraction.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
@@ -35,7 +35,7 @@ A self-hosted ebook management system built with Go, PostgreSQL, HTMX, and Tailw
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
3. Access the application at http://localhost:8765
|
||||
3. Access Shelf at http://localhost:8765
|
||||
|
||||
### Database
|
||||
|
||||
@@ -46,16 +46,15 @@ PostgreSQL runs on port 5432 with default credentials:
|
||||
|
||||
## Development
|
||||
|
||||
### Backend
|
||||
### Development
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
go mod tidy
|
||||
go run github.com/sqlc-dev/sqlc/cmd/sqlc@latest generate
|
||||
go run cmd/server/main.go
|
||||
```
|
||||
|
||||
The application uses Go HTML templates for server-side rendering with HTMX for dynamic interactions. Templates are located in `backend/templates/`.
|
||||
The application uses Go HTML templates for server-side rendering with HTMX for dynamic interactions. Templates are located in `templates/`.
|
||||
|
||||
**✨ Enhanced Features:**
|
||||
- **Authentication**: Login/Register forms with multiple theme support at `/login` and `/register`
|
||||
@@ -140,18 +139,20 @@ Use the included Bruno collection in the `bruno/` directory for testing the API:
|
||||
|
||||
```
|
||||
.
|
||||
├── backend/
|
||||
│ ├── cmd/server/ # Application entry point
|
||||
│ ├── internal/
|
||||
│ │ ├── config/ # Configuration management
|
||||
│ │ ├── database/ # Database connection and queries
|
||||
│ │ ├── handlers/ # HTTP handlers (auth + ebooks)
|
||||
│ │ └── services/ # Business logic services (ebook scanner)
|
||||
│ ├── migrations/ # Database migrations
|
||||
│ ├── templates/ # Go HTML templates with HTMX
|
||||
│ └── sqlc.yaml # sqlc configuration
|
||||
├── cmd/server/ # Application entry point
|
||||
├── internal/
|
||||
│ ├── config/ # Configuration management
|
||||
│ ├── database/ # Database connection and queries
|
||||
│ ├── handlers/ # HTTP handlers (auth + ebooks)
|
||||
│ └── services/ # Business logic services (ebook scanner)
|
||||
├── migrations/ # Database migrations
|
||||
├── templates/ # Go HTML templates with HTMX
|
||||
├── bruno/ # Bruno API testing collection
|
||||
├── docker-compose.yml
|
||||
├── Dockerfile # Docker build configuration
|
||||
├── docker-compose.yml # Docker Compose setup
|
||||
├── go.mod # Go module definition
|
||||
├── go.sum # Go module checksums
|
||||
├── sqlc.yaml # SQL code generation config
|
||||
└── README.md
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user