Scaffold

A scaffold to build a web application. The tech stack includes SpringBoot, FlyWay, docker, Junit5. Have big confidence that it the best practise about using SpringBoot to build an RESTFUL repo.

CI/CD for master

Setup in local

Prerequisites

  • Java 17
  • Docker

Start within docker

  auto/start

Start without docker

  1. Set up the database, use postgresql
  2. Make sure you have configured the IDEA environment. Configure application-local.yml. Edit the Active profile to local.
  3. Start in IDEA via BootApplication.

Run all the tests within docker

$ ./auto/test

Run all the tests without docker

$ ./gradlew clean check

Database

Deploy database

Use docker to set up the postgresql database.

docker-compose up db -d

Access API

curl -v http://localhost:8080

Build / Deployment

Deployment

Use git actions to trigger the CI/CD, see Github action

Support

Troubleshooting

See Troubleshooting

NewRelic

N/A