https://github.com/aistomin/andy.grails.backend
Andy Grails' Website. Backend
https://github.com/aistomin/andy.grails.backend
java java21 spring spring-boot
Last synced: about 1 month ago
JSON representation
Andy Grails' Website. Backend
- Host: GitHub
- URL: https://github.com/aistomin/andy.grails.backend
- Owner: aistomin
- Created: 2025-03-08T23:04:28.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2026-01-11T11:54:45.000Z (about 1 month ago)
- Last Synced: 2026-01-11T14:23:36.292Z (about 1 month ago)
- Topics: java, java21, spring, spring-boot
- Language: Java
- Homepage: https://andy-grails.de
- Size: 272 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Andy Grails' Website - Backend
[](https://github.com/aistomin/andy.grails.backend/actions/workflows/ci.yml)
[](https://codecov.io/gh/aistomin/andy.grails.backend)
This is the backend service for the [Andy Grails' website](https://andy-grails.de/).
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](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):**
```bash
./start.sh
```
2. **Alternative (manual):**
```bash
docker-compose up --build
```
> The API should be available at [http://localhost:8080](http://localhost:8080)
The Docker image is publicly available at [Docker Hub](https://hub.docker.com/r/andygrails/andy-grails-backend).
## API Documentation
Need to check the API documentation? Use these links:
- **Swagger UI**: [http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html)
Interactive docs to try out endpoints.
- **OpenAPI JSON**: [http://localhost:8080/v3/api-docs](http://localhost:8080/v3/api-docs)
Raw spec for tools or integrations.
## 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:
```bash
./mvnw clean install package javadoc:javadoc
```
**Note:** We use Testcontainers — make sure Docker is running when you build.
Also, check the [system requirements](#system-requirements).