Message Board

A restful API that serves as the backend for a message board. The branch also includes a simple frontend built on React, that is not feature complete or can be considered "production ready".

The main focus has been on backend.

Documentation

See the project's Javadoc.

Code Guide

We use GitHub Actions to make sure the codebase is consistent and continuously tested (gradle check). We try to keep comments at a maximum of 120 characters of length and code at 120.

Architecture

Hexagonal architecture.
DDD

Tools

Spring Boot
Hibernate
H2
SpotBugs
Error Prone
Checkstyle
Jacoco
Swagger
QueryDSL
React

Prerequisites

Docker
Make

Start the environment

make

Or directly using docker-compose

docker-compose up --build

The frontend can be accessed via

http://localhost:3000/

The backend can be accessed via