bookly

README

Bookly

Bookly is a monorepo, full-stack Go project that demonstrates a clean and simple backend architecture, coupled with a Y2K-inspired web application using Go templates and HTMX.

Overview

This project showcases a modern approach to building web applications with Go, featuring:

• A robust backend API
• A lightweight frontend using Go templates and HTMX
• Clean architecture principles
• GORM for database operations
• JWT-based authentication
• Docker-based deployment

Features

• User management (registration, login, profile updates)
• Account management
• Ledger entries for financial tracking
• RESTful API
• Server-side rendered web interface with HTMX for dynamic updates

Project Structure

• cmd/: Contains the main entry points for different executables
• app/: Application layer, including API and web handlers
• domain/: Core business logic and interfaces
• persistence/: Database related code, including migrations and repositories
• service/: Service layer implementing business logic
• deploy/: Deployment configurations
• Dockerfile.*: Docker build files for different services

Getting Started

Prerequisites

• Go 1.23+
• Docker and Docker Compose
• Taskfile

Setup and Running

1. Clone the repository:

   git clone https://github.com/omegaatt36/bookly.git
   cd bookly
   

2. Start all services using Docker Compose:

   task dev
   

   This command will:

   • Set up the PostgreSQL database
   • Run database migrations
   • Start the API server
   • Start the web server
   • Start Adminer for database management

3. Access the services:

   • Web interface: http://localhost:3000
   • API: http://localhost:8080
   • Adminer (database management): http://localhost:9527

4. Register a new user via command line:

curl -X POST 'http://localhost:8080/internal/auth/register' \
  -H 'Content-Type: application/json' \
  -H 'INTERNAL-TOKEN: secret' \
  -d '{"email":"tester","password":"tester"}'

Development

• Use task fmt to format the code
• Use task lint to run linters
• Use task test to run tests
• Use task live-api to run the API with live reloading(powered by Air)
• Use task live-web to run the web server with live reloading(powered by Air)

Database Management

• To set up the database: task setup-db
• To remove the database: task remove-db
• To run migrations: task migrate-api

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.