la-vie-spring

Backend server MVP that manages a REST API for a psychotherapy clinic.

This project is a rebuild of my first API, originally developed in JavaScript: la-vie-backend.

Created as part of the SpringBoot module in the +Devs2Blu program, 2023.

---

Specification

• Backend software developed using SpringBoot
• Data persistence through Postgresql
• UML Class Diagram
• Insomnia file with comprehensive API call examples
• API documentation using Swagger
• Requisite List
  • Functional Requirements
  • Non-Functional Requirements
  • Business Rules
• Minimum test coverage of 50% (Currently 54%)
• Database migrations using Flyway
• Build automation through Maven
• Adherence to clean code principles
• Data normalization process

---

Documentation chapters will be organized as Wiki this Repository Wiki articles:

1. The Story
2. Functional Requirements
3. Non-functional Requirements
4. Business Rules
5. UML Class Diagram

---

Installation

Docker

Prerequisites

Make sure you have Docker and Docker Compose installed on your system.

Steps

1. Clone the repo

git clone https://github.com/tiagospeckart/la-vie-spring.git
cd la-vie-spring

2. Build the Spring Boot Application

docker-compose build

3. Start the containers

docker-compose up -d

Local

You can use the dev profile in application.yml to start with a H2 virtual database, or use Postgres if you have it. Manually create a psych-clinic database

---

Swagger documentation

Access http://{context-path}:{port}/api/swagger-ui/index.html after SpringBoot initialization. On local machines, its http://localhost:8080/api/swagger-ui/index.html