Welcome to the extended documentation for nullInvoice. This directory contains detailed guides organized by topic.
Complete deployment instructions including:
- Docker Compose setup
- Database configuration and permissions
- Local development setup
- NetBeans IDE configuration
- First-run setup and admin account creation
- Emergency recovery procedures
Complete REST API documentation:
- Authentication methods (API keys and sessions)
- Invoice generation endpoints
- Invoice listing and filtering
- PDF retrieval
- Parties API
- OpenAPI/Swagger usage
Invoice template creation and customization:
- Template format requirements (XHTML)
- Available placeholders (30+ variables)
- PDF fonts and Unicode support
- Example templates in 6 languages
- Localization and multi-currency support
Environment variables and settings:
- Required and optional variables
- Timezone configuration (critical!)
- Session timeout customization
- Security best practices
- Production deployment checklist
- Database connection pooling
For contributors and developers:
- Project structure
- Building with Maven
- Tailwind CSS development
- Load testing scripts
- Database migrations
- Internationalization
- Code style guidelines
- Main README: ../README.md
- Example Templates: ../../templates/
- Docker Hub: https://hub.docker.com/r/nullata/nullinvoice
- GitHub Repository: https://github.com/nullata/nullInvoice
Each guide is self-contained and includes cross-references to related topics. You can read them in any order based on your needs:
- New to nullInvoice? Start with Deployment Guide
- Ready to integrate? Check API Reference
- Customizing invoices? See Template Customization
- Production deployment? Review Configuration Reference
- Contributing code? Read Development Guide