Skip to content

aistomin/andy.grails.backend

Repository files navigation

Andy Grails' Website - Backend

CI codecov

This is the backend service for the Andy Grails' website.
It is a Java Spring Boot application providing RESTful APIs to serve music data, media, and metadata consumed by the frontend.

For the full project including frontend and main repository, visit:
https://github.com/aistomin/andy.grails

System Requirements

  • Docker 28.2.2 or higher

For backend development, if you want to run the app or tests directly on your computer:

  • Docker Desktop 4.42.1 or higher
  • JDK 21 or higher
  • Apache Maven 3.9.8 or higher

How to Test and Run the App

To build and test the app, run: ./mvnw clean install package javadoc:javadoc

To start the app, you have two options:

  1. Recommended (ensures fresh build every time):

    ./start.sh
  2. Alternative (manual):

    docker-compose up --build

The API should be available at http://localhost:8080

The Docker image is publicly available at Docker Hub.

API Documentation

Need to check the API documentation? Use these links:

How to Contribute

Do you want to help us with the project? We would be more than happy to have your contribution!

Please: fork the repository, make changes, and submit a pull request. We promise to review your changes within the next couple of days and merge them to the master branch if they look correct. To avoid frustration, before sending us your pull request, please run the full Maven build:

./mvnw clean install package javadoc:javadoc

Note: We use Testcontainers — make sure Docker is running when you build. Also, check the system requirements.

About

Andy Grails' Website. Backend

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Languages