Voice Pick Backend

This is a Spring Boot Java backend for a Swift app named Voice Pick. The purpose of this project is to provide a REST API for the Swift app to interact with the backend.

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Java 8 or later
• Maven 3.5 or later
• Git

Installing

1. Clone the repository using the following command: git clone https://gitlab.com/IDATA-2900-Group-1/voice-pick-backend.git

2. Change into the directory: cd voice-pick-backend

3. Build the project with Maven: mvn clean install

4. Run the application: mvn spring-boot:run

API Documentation

The API documentation can be found in the /docs directory in the repository. It provides detailed information about the endpoints and how to interact with them.

Deployment

Can be deployed with:

docker build -t vp-backend .

docker run -d -p 8080:8080 --restart unless-stopped --name voice-pick-api vp-backend

Built With

• Spring Boot - The web framework used
• Maven - Dependency Management