Getting started

01 Choose a foundation

Start with the backend capability you need, then confirm the product boundary, compatibility, license, and access or storage model. Released BuildBaseKit boilerplates use the same local startup pattern.

02 Run without configuration

Clone or extract the project, enter its root directory, and use the included Maven wrapper. Do not create a .env file for the first run.

• Persistence-backed projects use an in-memory H2 database by default.
• Storage projects use local development storage by default.
• External services such as MySQL, AWS S3, Stripe, and production mail providers stay optional or disabled for the instant-run path.
• Demo data or development credentials are limited to the local evaluation flow.

./mvnw spring-boot:run

.\mvnw.cmd spring-boot:run

03 Try the APIs

After the application starts, open http://localhost:8080/api-test in a current browser. The project-hosted page lists the available APIs, sends same-origin requests, and keeps protected endpoints behind their normal authentication rules.

• Exercise public endpoints first.
• Use the displayed local demo credentials or registration flow for protected endpoints.
• Review each request and response without installing Postman or a separate frontend.
• Use the repository Postman collection when you need a repeatable guided workflow outside the browser.

04 Verify the project

• Automated tests complete without an external database or Docker for the default path.
• The application starts with no local values configured.
• The browser API testing page loads and protected requests keep their documented access rules.

./mvnw clean verify

.\mvnw.cmd clean verify

05 Configure for development

Copy .env.example to .env only after the default project is running and you are ready to adapt it. Uncomment only the values your application needs, then restart the project.

• Switch from H2 to a persistent database.
• Replace ephemeral or demo secrets with stable development values.
• Choose persistent local storage or an external provider.
• Enable optional integrations and product features.
• Disable demo data when it is no longer required.