Laptech Documentation
Laptech is a modern, production-ready authentication and authorization module built with Spring Boot 3.x, JWT tokens, and Spring Security. It provides secure user management, session handling, and role-based access control (RBAC).
π― What is Laptech?β
Laptech is an open-source backend service that implements enterprise-grade authentication with:
- β JWT-based authentication with access tokens
- β Secure refresh token rotation
- β Role-based access control (RBAC)
- β HttpOnly cookie storage for refresh tokens
- β Full Docker support for quick deployment
- β Environment-specific configuration (dev, staging, prod)
- β Spring Security integration
π Documentation Structureβ
Navigate through the documentation to get started:
Overviewβ
Understand the architecture and see planned improvements:
- Architecture: System design, component interactions, and data flows
- Improvements: Future enhancements and roadmap
Setup & Installationβ
Get Laptech running locally or in Docker:
- Installation: Complete setup guide with system requirements
- Database and Redis configuration
API Referenceβ
Detailed API documentation:
- Controllers: HTTP endpoints and routes
- Services: Business logic components
- DTOs: Request/response data structures
- Entities: Database models
- Examples: Real-world usage examples
Guidesβ
Step-by-step workflows and best practices
Troubleshootingβ
Common issues, FAQs, and debugging tips
π Quick Startβ
-
Clone the repository
git clone <repo-url> laptech-apicd laptech-api -
Setup environment
cp .env.example .env -
Run with Docker (recommended)
docker compose up --build -
Access the API
- Swagger:
http://localhost:8080/swagger - Health:
http://localhost:8080/actuator/health
- Swagger:
π Key Featuresβ
| Feature | Description |
|---|---|
| JWT Authentication | Stateless, scalable authentication |
| Refresh Token Rotation | Automatic token lifecycle management |
| RBAC | Role-based access control with Spring Security |
| HttpOnly Cookies | Secure refresh token storage |
| Multi-Environment | Dev, staging, and production profiles |
| Docker Ready | Pre-configured Docker Compose setup |
π Technology Stackβ
- Java 21 (LTS)
- Spring Boot 3.x (latest)
- Spring Security 6.x
- JWT (JSON Web Tokens)
- MySQL 8 (database)
- Redis (optional, for session management)
- Docker & Docker Compose
- Maven 3.9+
π‘ Common Tasksβ
- Set up your development environment
- Understand the architecture
- Explore API endpoints
- View code examples
- Troubleshoot common issues
π Support & Contributionβ
For issues, feature requests, or contributions, please visit the repository or contact the development team.