This is the REST API for e-cordel project.

In this project you can find an openapi specification with all the information about the endpoints available.

You can build with maven

mvn clean package

or, you can build a docker image

docker build . -t ecordel-restapi:1

To up postgres in a docker local

docker-compose up -d

Add in VMArguments to run in an IDE

-Dspring.profiles.active=local

You can run with maven

mvn spring-boot:run -Dspring-boot.run.profiles=local

or, you can run with docker if you already have an image

docker container run --name ecordel --rm -p 8080:8080 ecordel-restapi:1

tip: --rm parameter will exclude container image after execution and it cause data loss.

mvn test

If you wanna use db connection on your test you must extend the class AbstractIntegrationTest. This class will run the docker container and configure the spring datasource.

To get more help or find out how to contribute with this project please take a look at this page.