Giter Club home page Giter Club logo

la-vie-spring's Introduction

la-vie-spring

Java build CI with Maven Maven Tests passed

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
  1. Build the Spring Boot Application
docker-compose build
  1. 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

la-vie-spring's People

Contributors

tiagospeckart avatar

Stargazers

Bruno avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.