Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vishwajeet-29-pro/spring-boot-box

Central Repository for Spring Boot projects
https://github.com/vishwajeet-29-pro/spring-boot-box

flyway-migrations h2-database java jpa-hibernate mysql postgresql spring-boot swagger-ui

Last synced: about 2 months ago
JSON representation

Central Repository for Spring Boot projects

Awesome Lists containing this project

README 

        
# Spring Boot Box



A **modular Spring Boot project** designed to explore, implement, and master various functionalities and database integrations. Each module is self-contained and focuses on a specific feature, built with **Test-Driven Development (TDD)** at its core. This project serves as a learning and demonstration platform for best practices in Spring Boot development.



---



## Project Structure



```graphql

spring-boot-box/

├── settings.gradle.kts          # Gradle settings for module management

├── Makefile                     # Build, test, and run commands using Makefile

├── gradlew                      # Gradle wrapper script

├── gradlew.bat                  # Gradle wrapper for Windows

├── build.gradle.kts             # Root Gradle configuration

├── README.md                    # Project documentation

├── db-h2-connection/            # Module for H2 database integration

├── db-postgres-connection/      # Module for PostgreSQL integration

├── db-mysql-connection/         # Module for MySQL integration

├── db-mongo-connection/         # Module for MongoDB integration

├── (future modules...)          # Additional modules for extended functionalities

```



---



## Purpose and Philosophy



### Key Goals:



1. **Modular Design**:

    - Each module is independent and focuses on a specific feature or database.

    - Enables easy experimentation and integration of new ideas.

2. **TDD-Driven Development**:

    - Writing tests first to drive the implementation.

    - Ensures reliable, maintainable, and bug-free code.

3. **Learning-Focused**:

    - A sandbox for learning Spring Boot features, database integrations, and advanced concepts.



---

## Makefile Integration

This project uses a Makefile to simplify build, test, run, and other operations. The Makefile provides a consistent interface for managing project tasks across different environments. For Windows users, you can install `make` using [Chocolatey](https://docs.chocolatey.org/en-us/choco/setup/#install-with-cmdexe) by running the following command:

```bash

choco install make

```



## Current Modules



### **1. db-h2-connection**



- **Purpose**: Demonstrates integration with H2, an in-memory database.

- **Features**:

    - Quick prototyping and testing with in-memory persistence.

    - RESTful APIs for CRUD operations.

    - End-to-end tests for each feature.



### **2. db-postgres-connection**



- **Purpose**: Demonstrates integration with PostgreSQL.

- **Features**:

    - Production-grade persistence with PostgreSQL.

    - Proper connection pooling and configuration.

    - RESTful APIs and corresponding test cases.



### **3. db-mysql-connection**



- **Purpose**: Demonstrates integration with MySQL.

- **Features**:

    - Full MySQL database support for production use.

    - Comprehensive CRUD APIs.

    - Extensive testing for all operations.

 

### **4. db-mongodb-connection**



- **Purpose**: Demonstrates integration with MongoDB, a NoSQL database.

- **Features**:

    - Flexible schema design for NoSQL use cases.

    - RESTful APIs for CRUD operations.

    - Comprehensive test cases to ensure functionality.

    - Suitable for projects requiring horizontal scalability.



---



## Future Plans



### Planned Modules:



1. **Spring Security Integration**:

    - Implement basic authentication and authorization.

    - Secure endpoints using Spring Security features.

2. **Reactive Programming with WebFlux**:

    - Add R2DBC for reactive database operations.

3. **Advanced Functionalities**:

    - Explore Spring Cloud for microservices.

    - Build inter-service communication and monitoring.



### Testing Enhancements:



- Add mutation testing with PIT (Pitest).

- Introduce Behavior-Driven Development (BDD) using Cucumber.

- Focus on integrating test automation pipelines.



---



## Getting Started



### Prerequisites



- **Java 17+** (or preferred version).

- **Gradle** (build tool).



### Using the Makefile

1. Build and Test All Modules:

```bash

    make all

```

2. Build Modules:

```bash

    make

```

3. Clean All Build Files:

```bash

    make clean

```

4. Run the Root Spring Boot Application: (by default it runs h2 application)

```bash

    make run

```

5. Run the Specific Application: (e.g. h2 application)

```bash

    make run-h2

```

6. Build and Test a Specific Module:

```bash

    make run-module

```

7. Testing

Run all tests for the module:

```

    make test

```

8. Help

```bash

    make help

```

---



## OpenAPI Integration



The project leverages **OpenAPI** to provide interactive API documentation. This makes it easy to explore and test the REST APIs for each module.



### How to Access OpenAPI Documentation:



1. Start the Spring Boot application.

2. Navigate to the following URL in your browser

    ```bash

        http://localhost:8080/swagger-ui/index.html

    ```

   - Replace `8080` with the appropriate port if a different one is configured.

3. Explore the API endpoints, input parameters, and responses in an interactive interface.



## Contributions



Contributions are welcome! Feel free to fork the repository, create a new module, or enhance the existing ones.

-  [View Repository on GitHub](https://github.com/vishwajeet-29-pro/spring-boot-box)

---



## Author



**Vishwajeet Kotkar**



- A passionate developer focused on mastering Spring Boot, Test-Driven Development, and modern software practices.



Connect on [LinkedIn](https://www.linkedin.com/in/vishwajeet-kotkar/) or explore my other projects on [GitHub](https://github.com/vishwajeet-29-pro).