SitMe - Workspace Reservation System

SitMe is a Spring Boot application for managing workspace reservations, built with modern Java technologies and containerized with Docker.

📑 Table of Contents

• 🚀 Features
• 🛠️ Tech Stack
• 📋 Prerequisites
• 🏗️ Project Structure
• ⚙️ Configuration
• 🚀 Getting Started
• 🧪 Testing
• 📚 API Documentation
• 🔧 Key Features
• 🐳 Docker Support
• 🔄 CI/CD Pipeline
• 📝 API Usage Examples
• 🤝 Contributing
• 👩‍💻 Team
• 📄 License
• 🆘 Support

🚀 Features

• User Management: Registration, authentication, and profile management with JWT tokens
• Space Management: Create and manage different types of workspaces (rooms and tables)
• Reservation System: Book spaces for different time slots (morning, afternoon, full day)
• Image Upload: Profile and space images via Cloudinary integration
• Email Notifications: Automated registration confirmation emails
• Role-based Security: Admin and user roles with different permissions
• RESTful API: Comprehensive REST endpoints with Swagger documentation
• Database Integration: MySQL with JPA/Hibernate
• Health Checks: Actuator endpoints to monitor application status
• Containerization: Full Docker support with multi-stage builds
• Container Orchestration: Kubernetes for deploying and managing the application in a scalable way.
• Deployment Manifests: YAML files for Deployments, Services, ConfigMaps, and Kustomizations.

🛠️ Tech Stack

• Backend: Java 21, Spring Boot 3.5.5
• Database: MySQL 8.0
• Security: Spring Security with JWT authentication
• Image Storage: Cloudinary
• Email: Spring Mail (configured for MailHog in development)
• Testing: JUnit, Mockito
• API Documentation: Swagger/OpenAPI 3
• Containerization: Docker
• Build Tool: Maven
• CI: GitHub Actions
• CD: Kubernetes

📋 Prerequisites

• Java 21
• Maven 3.9+
• Docker
• MySQL 8.0 (if running locally without Docker)

🏗️ Project Structure

src/
├── main/java/com/femcoders/sitme/
│   ├── cloudinary/          # Image upload service
│   ├── config/              # CORS and Swagger configurations
│   ├── email/               # Email notifications
│   ├── reservation/         # Reservation management
│   ├── security/            # JWT security configuration
│   ├── shared/              # Common utilities and exceptions
│   ├── space/               # Workspace management
│   └── user/                # User management and authentication
└── main/resources/
    ├── templates/           # Thymeleaf templates
    ├── application.properties
    └── data.sql             # Initial data setup

⚙️ Configuration

Environment Variables

Create a .env file in the project root:

# Database Configuration
DB_URL=jdbc:mysql://localhost:3306/sitme
DB_USERNAME=your_db_username
DB_PASSWORD=your_db_password

# JWT Configuration
JWT_SECRET_KEY=your_jwt_secret_key
JWT_EXPIRATION=1800000

# Server Configuration
SERVER_PORT=8080

# MailHog Configuration
spring.mail.host=localhost
spring.mail.port=1025
spring.mail.username=
spring.mail.password=
spring.mail.properties.mail.smtp.auth=false
spring.mail.properties.mail.smtp.starttls.enable=false

# Cloudinary Configuration (for image uploads)
CLOUDINARY_NAME=your_cloudinary_name
CLOUDINARY_KEY=your_cloudinary_api_key
CLOUDINARY_SECRET=your_cloudinary_secret

🚀 Getting Started

Option 1: Using Docker Compose (Recommended)

1. Clone the repository:

   git clone https://github.com/femcoders-sitme/sitme.git
   cd sitme

2. Start the application:

   docker-compose up -d

3. Access the application:

   • API: http://localhost:8081
   • Database: localhost:3307
   • Swagger Documentation: http://localhost:8081/swagger-ui.html

Option 2: Local Development

1. Install dependencies:

   mvn clean install

2. Run the application:

   mvn spring-boot:run

3. Access the application:

   • API: http://localhost:8080
   • Swagger Documentation: http://localhost:8080/swagger-ui.html

🧪 Testing

Run Test Suite

mvn test

Run Test Suite with Docker

docker-compose -f docker-compose-test.yml up --abort-on-container-exit

The test suite includes:

• Unit tests for all service layers using Mockito
• Integration tests for REST endpoints

📚 API Documentation

Authentication Endpoints

• POST /api/auth/register - User registration
• POST /api/auth/login - User login (returns JWT token)

User Management

• GET /api/users/me - Get own user profile (USER/ADMIN)
• PUT /api/users/me - Update own user profile (USER/ADMIN)
• GET /api/users - Get all users (Admin only)
• GET /api/users/{id} - Get user by ID (Admin only)
• PUT /api/users/{id} - Update user profile (Admin only)
• DELETE /api/users/{id} - Delete user (Admin only)
• POST /api/users/{id}/image - Upload user profile image
• DELETE /api/users/{id}/image - Delete user profile image

Space Management

• GET /api/spaces - Get all spaces
• GET /api/spaces/{id} - Get space by ID
• GET /api/spaces/filter/type?type={TYPE} - Filter spaces by type (ROOM/TABLE)
• GET /api/spaces/filter/available - Get available spaces only
• POST /api/spaces - Create new space (Admin only)
• PUT /api/spaces/{id} - Update space (Admin only)
• DELETE /api/spaces/{id} - Delete space (Admin only)

Reservation Management

• GET /api/reservations/me - Get own reservations (USER/ADMIN)
• POST /api/reservations - Create new reservation (USER only)
• PUT /api/reservations/{id} - Update reservation (USER/ADMIN)
• PATCH /api/reservations/{id}/cancel - Cancel reservation (USER/ADMIN)
• GET /api/reservations - Get all reservations (Admin only)
• GET /api/reservations/{id} - Get reservation by ID (Admin only)
• DELETE /api/reservations/{id} - Delete reservation (Admin only)

Swagger & Actuator

• /swagger-ui.html, /swagger-ui/**, /v3/api-docs/** - API documentation
• /actuator/** - Application health and metrics

Default Users

The application comes with preloaded test data:

• Admin: username: admin, password: Password123.
• Test Users: username: debora, roberto, jenni, etc. (password: Password123.)

🔧 Key Features

Security

• JWT-based authentication
• Role-based authorization (USER/ADMIN roles)
• Password encryption with BCrypt
• CORS configuration for API access

Observability

• Spring Boot Actuator integration for health checks and monitoring endpoints

Image Management

• Cloudinary integration for image storage
• File validation (size and format)
• Automatic cleanup when images are deleted

Email System

• Registration confirmation email
• Reservation notifications: email sent when a reservation is created, updated, or cancelled
• Configurable SMTP settings
• MailHog integration for development

Database

• MySQL with JPA/Hibernate
• Automatic schema creation
• Pre-loaded test data
• Connection pooling

🐳 Docker Support

Development

docker-compose up -d

Testing

docker-compose -f docker-compose-test.yml up --abort-on-container-exit

Production Build

The application uses multi-stage Docker builds for optimized production images.

🔄 CI/CD Pipeline

GitHub Actions workflows included:

• Test: Runs on pull requests
• Build: Builds and pushes Docker images on main branch pushes
• Release: Creates releases and pushes tagged images
• Deploy: Triggers Kubernetes deployment workflows

☸️ Kubernetes Deployment

• Container Orchestration: Deploy the application using Kubernetes
• Manifests: Includes YAML files for Deployment, Service, and ConfigMap
• Kustomization: Manage overlays and environment-specific configurations
• Scalability: Horizontal Pod Autoscaler for dynamic scaling
• Persistent Storage: PersistentVolumeClaims for database and file storage
• Monitoring & Logging: Optional integration with Prometheus/Grafana

🏗️ CI/CD & Kubernetes Workflow

[Developer]
└─ pushes code
▼
[GitHub Repository]
└─ triggers workflow
▼
[GitHub Actions CI/CD]
├─ Run tests
├─ Build Docker image
├─ Push image to registry
└─ Deploy to Kubernetes
▼
[Kubernetes Cluster]
├─ Deployment: runs pods with your app
├─ Service: exposes app internally/externally
├─ ConfigMap & Secrets: app configuration
├─ HPA: auto-scaling pods
└─ PersistentVolumeClaims: database & file storage

📝 API Usage Examples

Register a new user

curl -X POST http://localhost:8080/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "maria",
    "email": "maria@example.com",
    "password": "SecurePass123!"
  }'

Login

curl -X POST http://localhost:8080/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "maria",
    "password": "SecurePass123!"
  }'

Get all spaces

curl -X GET http://localhost:8080/api/spaces

🤝 Contributing

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

👩‍💻 Team

• Débora Rubio – Scrum Master and Developer
• Lara Pla – Product Owner and Developer
• Mariia Sycheva – Developer
• Mayleris Echezuria – Developer
• Vita Poperechna – Developer
• Saba Ur Rehman – Developer

📄 License

This project is part of a learning bootcamp and is intended for educational purposes.

🆘 Support

For questions or issues, please create an issue in the repository or contact the development team.

---

Built with 💜 using Spring Boot and modern Java technologies