🧾 Billgen Pro - Professional Billing Made Simple

📱 About

Billgen Pro is a secure billing application built with Spring Boot and Thymeleaf for generating professional invoices and receipts. It features user authentication, data isolation, and BCrypt password protection. Users can easily create, manage, and export invoices or receipts as PDFs, with automatic tax calculations and real-time total updates. The Bootstrap-based responsive UI ensures a smooth and professional billing experience.

⚡️ Key Features

• User Authentication: Secure user registration and login with Spring Security
  • Email-based authentication with password validation
  • BCrypt password hashing for secure password storage
  • User-specific data isolation (users can only access their own invoices and receipts)
  • Protected routes requiring authentication
• Invoice Generation: Create and customise professional invoices with company info, items, taxes, and notes
• Receipt Generation: Generate receipts with multiple template options
• PDF Export: Export invoices and receipts as professional PDFs using iText
• Data Persistence: Store invoices and receipts in a database with full CRUD operations
• Tax Calculations: Automatic tax calculations with configurable tax rates
• Responsive Design: Bootstrap-based responsive web interface
• Item Management: Dynamic item addition/removal with real-time total calculations

🛠 Tech Stack

• Backend: Spring Boot 3.2.0
• Security: Spring Security with form-based authentication
• Database: MySQL (production) / H2 (development)
• Template Engine: Thymeleaf
• PDF Generation: iText 7
• Frontend: HTML5, CSS, Bootstrap 5
• Build Tool: Maven
• Java Version: 17+
• Containerization: Docker & Docker Compose

🚀 Getting Started

Prerequisites

• Java 17 or higher
• Maven 3.6+ (for local development)
• Docker and Docker Compose (for containerized deployment)
• MySQL database (for production)

Local Development

Option A: Using Docker Compose (Recommended - No MySQL setup needed)

# Make sure Docker Desktop is running, then:
./deploy.sh start

Option B: Local MySQL Setup

1. Set up MySQL database (see MYSQL_SETUP.md):

   mysql -u root -p
   CREATE DATABASE billgenpro;

2. Run with helper script:

   ./run-local.sh

   Or manually set environment variables:

   export SPRING_DATASOURCE_PASSWORD=your_mysql_password
   mvn spring-boot:run

3. Access the application:

   • Main application: http://localhost:5000
   • Login page: http://localhost:5000/login
   • Registration page: http://localhost:5000/register

Having MySQL connection issues? See LOCAL_SETUP.md for detailed troubleshooting.

Quick Deployment (Docker)

1. Clone the repository:

   git clone <repository-url>
   cd billgen-pro-main

2. Deploy with Docker Compose:

   ./deploy.sh start

   Or manually:

   docker-compose up -d

3. Access the application:

   • Application: http://localhost:3000 (default port, change HOST_PORT in docker-compose.yml if needed)

For more deployment options, see QUICKSTART.md or DEPLOYMENT.md

First-Time Setup

1. Register a new account:

   • Navigate to http://localhost:5000/register
   • Enter your name, email, and password (minimum 6 characters)
   • Click "Register" to create your account

2. Login:

   • Use your registered email and password to login at http://localhost:5000/login
   • After successful login, you'll be redirected to the home page

📋 Usage

Authentication

Registration:

1. Navigate to /register or click "Register here" on the login page
2. Fill in your name, email, and password
3. Password must be at least 6 characters long
4. Email must be unique (not already registered)
5. Upon successful registration, you'll be redirected to the login page

Login:

1. Navigate to /login or access any protected route
2. Enter your registered email and password
3. After successful authentication, you'll be redirected to the home page
4. All invoices and receipts are user-specific - you'll only see your own data

Logout:

• Click the logout button in the navigation menu
• You'll be logged out and redirected to the login page

Security Features:

• Passwords are securely hashed using BCrypt before storage
• All application routes except /register, /login, and static resources require authentication
• Session-based authentication maintains your login state
• User data isolation ensures each user only accesses their own invoices and receipts

Creating Invoices

1. Login to your account (required)
2. Navigate to the home page or click "Create Invoice"
3. Fill in company information, invoice details, and items
4. The invoice will be automatically associated with your user account
5. Save the invoice
6. Download as PDF or view/edit later

Creating Receipts

1. Login to your account (required)
2. Click "Create Receipt" or go to /receipts/new
3. Enter company details, receipt information, and items
4. Add notes and footer message
5. The receipt will be automatically associated with your user account
6. Save and download as PDF

Managing Data

• View your invoices: /invoices - Shows only invoices created by the logged-in user
• View your receipts: /receipts - Shows only receipts created by the logged-in user
• Edit existing documents by clicking the edit button
• Delete documents with confirmation
• Download PDFs directly from the list view
• All data is isolated per user account

🏗 Project Structure

src/
├── main/
│   ├── java/com/billgenpro/
│   │   ├── BillgenProApplication.java    # Main application class
│   │   ├── controller/                   # Web controllers
│   │   │   ├── AuthController.java       # Authentication endpoints
│   │   │   ├── HomeController.java
│   │   │   ├── InvoiceController.java
│   │   │   └── ReceiptController.java
│   │   ├── config/                       # Configuration classes
│   │   │   ├── SecurityConfiguration.java # Spring Security config
│   │   │   └── CustomUserDetailsService.java # User authentication service
│   │   ├── model/                        # JPA entities
│   │   │   ├── User.java                 # User entity
│   │   │   ├── Invoice.java
│   │   │   ├── InvoiceItem.java
│   │   │   ├── Receipt.java
│   │   │   ├── ReceiptItem.java
│   │   │   ├── Company.java
│   │   │   └── BillTo.java
│   │   ├── repository/                   # Data repositories
│   │   │   ├── UserRepository.java       # User data access
│   │   │   ├── InvoiceRepository.java
│   │   │   └── ReceiptRepository.java
│   │   └── service/                      # Business logic
│   │       ├── UserService.java          # User registration and management
│   │       ├── InvoiceService.java
│   │       ├── ReceiptService.java
│   │       └── PdfService.java
│   └── resources/
│       ├── templates/                    # Thymeleaf templates
│       │   ├── index.html
│       │   ├── login.html                # Login page
│       │   ├── register.html             # Registration page
│       │   ├── invoices/
│       │   └── receipts/
│       └── application.properties        # Configuration

🔧 Configuration

The application is configured to use MySQL database. Configuration can be done via:

1. Environment variables (recommended for production):

   • SPRING_DATASOURCE_URL
   • SPRING_DATASOURCE_USERNAME
   • SPRING_DATASOURCE_PASSWORD

2. application.properties (for local development):

   spring.datasource.url=jdbc:mysql://localhost:3306/billgenpro
   spring.datasource.username=your_username
   spring.datasource.password=your_password
   spring.jpa.hibernate.ddl-auto=update

See application.properties for all configuration options.

📊 API Endpoints

Authentication Routes (Public)

• GET /login - Display login page
• POST /login - Process login form submission
• GET /register - Display registration page
• POST /register - Process user registration
• POST /logout - Logout user (redirects to login)

Protected Routes (Require Authentication)

• GET / - Home page (dashboard)
• GET /invoices - List all invoices for logged-in user
• GET /invoices/new - Create new invoice form
• POST /invoices/save - Save invoice (associated with current user)
• GET /invoices/{id} - View invoice (only if owned by user)
• GET /invoices/{id}/edit - Edit invoice form (only if owned by user)
• GET /invoices/{id}/pdf - Download invoice PDF (only if owned by user)
• GET /invoices/{id}/delete - Delete invoice (only if owned by user)
• GET /receipts - List all receipts for logged-in user
• GET /receipts/new - Create new receipt form
• POST /receipts/save - Save receipt (associated with current user)
• GET /receipts/{id} - View receipt (only if owned by user)
• GET /receipts/{id}/edit - Edit receipt form (only if owned by user)
• GET /receipts/{id}/pdf - Download receipt PDF (only if owned by user)
• GET /receipts/{id}/delete - Delete receipt (only if owned by user)|

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🚀 Deployment

Quick Deploy Options

• Docker Compose (Self-hosted): See QUICKSTART.md
• Railway (Cloud): See QUICKSTART.md
• Heroku (Cloud): See QUICKSTART.md
• Render (Cloud): See QUICKSTART.md
• AWS/Google Cloud/DigitalOcean: See DEPLOYMENT.md

For detailed deployment instructions, see:

• QUICKSTART.md - Quick deployment guide
• DEPLOYMENT.md - Comprehensive deployment guide

📞 Support

For issues and questions:

1. Check the existing issues in the repository
2. Create a new issue with a detailed description
3. Include steps to reproduce any bugs

---

Built with ❤️ by Abhiraj