Home

Welcome to the efficient-mvp-example wiki!

This project is an example of how you can create an impressive MVP in a short time. Visit keepgrowing.in to learn more about tools and techniques used to create this project.

Getting started

First, clone this repository.

Then, build it locally with:

mvn clean install

In order to run the application visit Setting up a local environment to learn how to start all required dependencies. Once the dependencies are working, you can run the app in a command line adding all spring profiles you need (at least dev for the default database connection):

mvn spring-boot:run -Dspring-boot.run.profiles=dev

Profiles summary

The project can be built with various different profiles to allow for flexible configuration. Below you'll find a short summary of the available profiles.

Spring profiles

• dev - for establishing a default database connection, default credentials, etc.
• dbschema - saves Hibernate DDL schema to the schema.sql file (added to .gitignore)
• init - enables data initialization
• monitoring - when the applicaiton runs alongside the monitoring services (Grafana, Loki, etc.)
• angular - used for client code generation. Applied automatically when the angular Maven profile is enabled.

Maven profiles

• sonar-cloud - for code analysis on push to master
• code-coverage - for including code coverage reports from the backend module during a sonar analysis
• frontend-pre-sonar - for including code coverage reports from the frontend module during a sonar analysis
• frontend-sonar - for running only a sonar analysis for the frontend module
• angular - for generating client code

Built With

• Spring Boot v2.6+
• Angular v13+
• Maven
• frontend-maven-plugin
• Flyway
• PostgreSQL
• Docker Compose
• springdoc-openapi
• OpenAPI Generator maven plugin
• Dummy4j
• Testcontainers
• Bootstrap v5+
• ng-bootstrap