πΏ create, manage and rate movies and series api
- About
- Technology
- Installation and Configuration
- Running the Application
- Docs
- Issues
- Contribution
- License
This repository contains the source code of the api that manages lists of movies and series. The technologies used are described in Technology. The implementation project of this api can be consulted here
- Java 17
- Maven
- Spring Framework
- Spring Data JPA
- Spring Security
- Hibernate
- H2Database
- Postgres
- Junit5
- Docker
- Docker Compose
- Springfox
- Flyway
To execute the project in a development environment, it is necessary to have the tools installed. Can be consulted in the technology section
This project can also be run by docker. You must have docker installed. Run the command
docker-compose up --build
Access the api with the url localhost:8080/api/v1
Run the command to perform the dependency installation
mvn clean install
To run the application tests it is necessary to change the profile to 'test'. Create an .env file based on .env-example
PROFILE_ACTIVE=test
DB_USERNAME=postgres
DB_PASSWORD=1234
Run the command
mvn test
Create the database moviecatchdb
and then change the environment variable database credentials. Check
example .env-example
PROFILE_ACTIVE=dev
DB_USERNAME=postgres
DB_PASSWORD=1234
This application uses flyway as a database migration tool. Scripts are located here
Run Application in development mode after installation and configuration
mvn spring-boot:run
Access the api with the url localhost:8080/api/v1
To access API documentation localhost:8080/api/v1/docs
Application documents and files can be found in the docs
directory.
Some of the types of documents that can be found.
- Entity and database tables in
database
- Application flow and use cases in
application
- Collections of postman requests in
collection
To access the running API swagger documents. Access a url /docs
I would love to review your pull request! Open a new issue
Feel free to contribute to the project. I am open for suggestions. Click here to open a new issue or take part in the development project π
This project uses MIT License. Click here to access
Developed π by Fredson Chaves