Screenmatch is a Spring Boot-based Java application designed as an introductory project for working with the framework. It leverages several key technologies, including PostgreSQL for database management and OpenAI integration for additional functionalities.
- RESTful API using Spring Boot
- PostgreSQL database integration with Spring Data JPA
- Environment variable management using
java-dotenv
- JSON processing with Jackson
- Development tools enabled via
spring-boot-devtools
- Java 21
- Maven
- PostgreSQL database
-
Clone the repository:
git clone https://github.com/your-username/screenmatch.git cd screenmatch
-
Configure environment variables:
- Create a
.env
file in the project's root and specify required environment variables.
- Create a
-
Build and run the application:
mvn clean install mvn spring-boot:run
The project uses the following dependencies:
spring-boot-starter
- Core Spring Boot featuresspring-boot-starter-web
- Enables REST API functionalitiesspring-boot-devtools
- Hot reload for developmentjava-dotenv
- Environment variable managementjackson-databind
- JSON serialization and deserializationspring-boot-starter-data-jpa
- Database access using JPApostgresql
- PostgreSQL database driveropenai-gpt3-java
- OpenAI API integration
To run tests, execute:
mvn test
(Provide specific API routes and their functionalities here)
This project is licensed under the MIT License.