An advanced and scalable API for managing events and venues, built with modern technologies and principles. This project is designed to deliver robust performance, maintainable code, and seamless integration with existing systems.
- Event Management: Create, update, delete, and retrieve events with ease.
- Venue Management: Manage venue details, availability, and bookings.
- Clean Architecture: Following Clean Architecture principles for better code organization and maintainability.
- Database Versioning: Leveraging Flyway for consistent and traceable database migrations.
- Containerization: Built with Docker for simplified deployment and scalability.
- Modern Java: Developed with Java 17, utilizing the latest language features.
- Java 17: Modern Java features for cleaner and more efficient code.
- Spring Framework: Includes Spring Boot for rapid development and Spring Data for database interaction.
- Docker: Containerized application for easy deployment.
- Flyway: For managing database schema migrations.
- PostgreSQL: Reliable and scalable database backend.
The project follows the principles of Clean Architecture, ensuring:
- Separation of Concerns: Dividing the application into clear layers (Domain, Application, Infrastructure, and Presentation).
- Testability: High test coverage and easily testable components.
- Flexibility: Easy adaptability for new features and integrations.
src
├── main
│ ├── java
│ │ └── com.example.eventmanagement
│ │ ├── application # Application logic
│ │ ├── domain # Core business rules
│ │ ├── infrastructure # External integrations and database
│ │ └── presentation # Controllers and REST endpoints
│ └── resources
│ ├── db/migration # Flyway migrations
│ └── application.yml # Application configuration
└── test
└── java # Unit and integration tests
Ensure you have the following installed:
-
Clone the repository:
git clone https://github.com/horaciomuller/EventClean.git cd event-management-api -
Start the application with Docker:
docker-compose up
-
Access the API documentation (Swagger):
http://localhost:8080/swagger-ui/index.html
- GET /events: Retrieve a list of events.
- POST /events: Create a new event.
- PUT /events/{id}: Update an event by ID.
- DELETE /events/{id}: Delete an event by ID.
- GET /venues: Retrieve a list of venues.
- POST /venues: Create a new venue.
- PUT /venues/{id}: Update a venue by ID.
- DELETE /venues/{id}: Delete a venue by ID.
This project uses Flyway for database schema migrations. All migration scripts are located in the src/main/resources/db/migration folder. To run migrations manually, use:
mvn flyway:migrateRun unit tests with:
mvn testEnsure the database is running and execute:
mvn verifyContributions are welcome! Please follow these steps:
- Fork the repository.
- Create a feature branch:
git checkout -b feature-name - Commit your changes:
git commit -m 'Add new feature' - Push to the branch:
git push origin feature-name - Submit a pull request.
This project is licensed under the MIT License.
For questions or feedback, please contact us at [email protected].