Community Workspace For Small Communities
A Community Workspace Project for Small Communities with Spring Boot 3.2.1, JDK 21 & Gradle 8.5.
Services are developed in the following modules:
- Community Manager - Community Manager Service in order to manage community related functionalities.
- Service Discovery - Service Discovery Service in order to discover other services.
- API Gateway - API Gateway of the Overall Community Workspace.
- User Manager - User Manager Service in order to manage user related functionalities.
- Venue Manager - Venue Manager Service in order to manage venue related functionalities.
- Event Manager - Event Manager Service in order to manage Event related functionalities.
Table of Contents
How to Contribute
For the contributor covenant to this project, please check the Code of Conduct file.
Credits
Please check the Contributors List to see who makes this open-source alive.
Requirements
For building and running the application belows are required;
- Spring Boot 3.2.1
- JDK 21
- Gradle 8.5 or above
- PostgreSQL
- Flyway Migration
- Eureka Client
- Spring Cloud Config Server
- Spring Boot Actuator
Version Control Standards
Below version control standards should be followed within the project;
- The default branch is staging branch.
- Feature enhancements or defect fixes should not be committed to the default branch, they should be coded in feature or bug branches.
- Issues should be created for each feature or fix in the Community Workspace GitHub Repository Project.
- Pull request (PR) should be created for each feature/bug branch to staging branch.
- While creating a PR "[Feature]: ", "[Bug]: " or "[Chore]: " prefix should be used to identify the PR type.
- PRs should be linked with a valid issue in the Community Workspace GitHub Repository Project.
- If validations are passed in the staging branch, then a merge branch request is created with "merge branch" label & a linked PR to the main branch.
Postman Collection
You can find the postman collection within this file.
Copyright
GNU General Public License v3.0 Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. Please check the LICENSE file for more details.