beer-api

REST API for managing beer stocks.

📝 TODO

• API documentation with Swagger
• Deploy in Heroku

💻 Prerequisites

• JDK 11
• Intellij IDEA

💻 Technology

• Java 11
• Spring
  • JPA
  • Validation
  • Web
  • DevTools
  • Actuator
• MapStruct
• H2
• Lombok
• JUnit / Mockito / Hamcrest
• Swagger 2

🚀 Installation

# Repository clone
$ git clone https://github.com/ImGabreuw/beer-api

# Go to the application directory
$ cd beer-api/

# Start the application
$ mvn spring-boot:run

Go to http://localhost:8080/api/v1/beers

📫 Contribution

To contribute to beer-api, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <feature>.
3. Make your changes and confirm them: git commit -m 'feature'
4. Send to the original branch: git push origin <feature>
5. Create the pull request.

Alternatively, refer to the GitHub documentation at how to create a pull request.

🤝 Contributors

We thank the following people who contributed to this project:

ImGabreuw

😄 Be one of the contributors

Want to be part of this project? Click HERE and read how to contribute.

📝 License

This project is under license. See the archive LICENSE for more details.

⬆ Back to the top