Skip to content

docs: add Maven Wrapper usage instructions for issue #26 #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nalwogatracy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Maven Wrapper usage instructions for issue #26 #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,37 @@ GreenCode/
└── docker-compose.yml # Docker orchestration


## 🛠️ Using Maven Wrapper

This project includes the Maven Wrapper (`mvnw`) to ensure consistent builds across all environments without requiring Maven to be installed globally.

### Why Use Maven Wrapper?
- ✅ No need to install Maven separately
Copy link
Copy Markdown
Contributor

@RonaldRonnie RonaldRonnie Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the documentation update - this is helpful 👍
However, the issue requires adding the actual Maven Wrapper files (mvnw, mvnw.cmd, .mvn/) to the repository.

Right now, the README references ./mvnw, but those files are not present, so the commands will fail.

Please generate the wrapper using:

mvn wrapper:wrapper

and commit the generated files so the project can build without requiring a global Maven installation.

- ✅ Everyone uses the same Maven version
- ✅ Builds are reproducible
- ✅ Works on CI/CD pipelines

### Commands

```bash
# On Linux/Mac
./mvnw clean install
./mvnw spring-boot:run
./mvnw test

# On Windows
mvnw.cmd clean install
mvnw.cmd spring-boot:run
mvnw.cmd test


### Step 4: Commit and push

```bash
git add README.md
git commit -m "docs: add Maven Wrapper usage instructions for issue #27

- Added mvnw commands for Linux/Mac/Windows
- Explained benefits of using Maven Wrapper
- Added instructions to generate wrapper if missing"
git push origin fix/issue-27-maven-wrapper