Description • Features • Installation • Contribution
The SPOT Management System API is a backend service developed in Java with Spring Boot to support the SPOT Management System web application. This API provides endpoints for managing SPOTS, which are short recordings sold by a radio company. The API facilitates the registration and management of announcers, associated companies, and spots, making it easy to control and search for all registered spots.
- Announcer Registration: Endpoints to add and manage announcers who make the recordings.
- Company Registration: Endpoints to add and manage companies associated with the recordings.
- Spot Registration: Endpoints to add and manage spots, specifying the title, announcer, and associated company.
- Java: Primary programming language.
- Spring Boot: Framework for building the backend.
- Spring Data JPA: For data persistence and database interaction.
- Hibernate: ORM for mapping Java objects to database tables.
- PostgreSQL: Database used for storing data.
- Maven: For project management and dependency management.
- Java Development Kit (JDK) 17 or higher
- Maven for dependency management
- PostgreSQL database
- Clone the repository to your local environment:
git clone https://github.com/lucasrznd/api-gspot.git
- Configure your database:
spring.datasource.url=${POSTGRES_URL}
spring.datasource.username=${POSTGRES_USER}
spring.datasource.password=${POSTGRES_PASSWORD}
spring.datasource.driver-class-name=org.postgresql.Driver
- Navigate to the project directory:
cd api-gspot
- Compile the project using Maven:
mvn clean install
- Run the generated JAR file in the target folder or deploy the JAR to your application server.
Contributions are welcome! If you have suggestions, improvements, or find bugs, feel free to open an issue or submit a pull request.
Lucas Rezende 💻 |