Project Log Server

Project Risk and Issue Tracker.

Technology

Production Code

• Language: Java
• Application Server (Servlet Container): Apache Tomcat
• Application and Web Framework: Spring Boot
• Code Generation: Project Lombok

Test Code

• Spring Boot Test
• Rest Assured
• Test Containers

Tooling

• Build: Gradle
• Code Formatting: Spotless with Google Style Guide
• Containerization: Docker

Build, Run and Test

The recommended gradle wrapper is used to build the application and is included in the source code.

Build

• With Gradle: ./gradlew build
• With Docker: sudo docker build -t trevorgowing/project-log-server:X.X.X .
• With Docker Compose: sudo docker-compose build project-log-server

Run

• With Gradle: ./gradlew bootrun (will build if not already built)
• With Docker: sudo docker run trevorgowing/project-log-server:X.X.X (needs to be built explicitly)
• With Docker Compose: sudo docker-compose --build up
• With Bash Script: ./start.sh (runs docker-compose internally)

Test

• With Gradle: ./gradlew test

Release

1. Merge feature branch into master
2. Update the version number in build.gradle
3. Update the version number in Dockerfile
4. Commit changes with message Release X.X.X
5. Tag release commit with git tag -a vX.X.X and include a description 'Brief summary followed by list of significant changes'
6. Push to master with git push --follow-tags

License

MIT License