A minimal Spring Boot starter project using Maven β preconfigured with the Maven Wrapper to make it easy to build and run locally.
- Overview
- Features
- Tech stack
- Prerequisites
- Run locally
- Build
- Tests
- Project structure
- Configuration
- Roadmap
- Contributing
- Author
- License
This repository contains a lightweight Spring Boot application set up using Apache Maven and the Maven Wrapper. It is intended as a simple starting point for building REST APIs, experimenting with Spring Boot features, or teaching core concepts.
- Spring Boot application starter
- Maven Wrapper included (no global Maven required)
- Ready to build into an executable JAR
- Placeholder for adding REST endpoints, persistence, and security
- Java (JDK 17+ recommended)
- Spring Boot
- Maven
- Maven Wrapper
- Java JDK 17 or newer
- Git
- (Optional) Docker β if you plan to add containerization later
-
Clone the repository
git clone https://github.com/Avinash2k4/Store-spring-boot-basic.git cd Store-spring-boot-basic
-
Run with Maven Wrapper
Linux / macOS ./mvnw spring-boot:run
Windows mvnw.cmd spring-boot:run
-
Open http://localhost:8080 (or the port configured in application.properties)
Build an executable JAR using the wrapper:
Linux / macOS ./mvnw clean package
Windows mvnw.cmd clean package
Run the generated JAR:
java -jar target/*.jar
Execute unit tests with:
./mvnw test
.
βββ .mvn/ # Maven wrapper files
βββ mvnw, mvnw.cmd # Maven wrapper scripts
βββ pom.xml # Maven configuration
βββ src/main/java/ # Application source
βββ src/main/resources/ # Application resources (application.properties)
βββ target/ # Build output (generated)
Edit src/main/resources/application.properties (or application.yml) to change server port, datasource settings and other properties.
Planned enhancements:
- Add sample REST endpoints for a store (products, orders, customers)
- Integrate with a database (H2 / MySQL / PostgreSQL)
- Add Spring Security for authentication and authorization
- Containerize with Docker
Contributions are welcome. Please open an issue or submit a pull request describing your changes.
Avinash P β Aspiring Software Engineer
This project is provided under the MIT License. See LICENSE for details.