An open API service indexing awesome lists of open source software.

https://github.com/duduxs/product-ms-quarkus

🖖 API developed using concepts as containers, github actions, code archictetures, and many others.
https://github.com/duduxs/product-ms-quarkus

api docker docker-compose hibernate-validator jax-rs junit5 mongodb morphia product-ms project quarkus restassured swagger testcontainers

Last synced: 2 months ago
JSON representation

🖖 API developed using concepts as containers, github actions, code archictetures, and many others.

Awesome Lists containing this project

README

          


Product MicroService



This application was developed during the UOL Compass' selection process.

This project is based in CRUD(Create, Read, Update and Delete) with Quarkus and Java.



Technologies   |   
How To Use   |   
How To Contribute   |   
License


Collage

## :rocket: Technologies

This project was developed with the following technologies:

- API:

- [Java](https://www.oracle.com/br/java/)
- [Quarkus](https://quarkus.io/)
- [Mongo](https://www.mongodb.com/pt-br)
- [Morphia](https://github.com/MorphiaOrg/morphia)
- [JAX-RS](https://en.wikipedia.org/wiki/Jakarta_RESTful_Web_Services)
- [Hibernate Validator](http://hibernate.org/validator/)

- Utils:

- [Swagger](https://quarkus.io/guides/openapi-swaggerui)

- Tests:

- [JUnit5](https://junit.org/junit5/docs/current/user-guide/)
- [RestAssured](https://rest-assured.io/)
- [TestContainers](https://www.testcontainers.org/)

## :information_source: How to use
To clone and run this application, you'll need [Git](https://git-scm.com), [Docker](https://www.docker.com/) and [DockerCompose](https://docs.docker.com/compose/) installed on your computer. From your command line:

Cloning the project:

```bash
# Clone this repository
$ git clone https://github.com/duduxs/product-ms-quarkus

# Go into the repository
$ cd product-ms-quarkus
```

Run only API local and mongo in docker:

```bash
$ ./mvnw compile quarkus:dev
$ docker-compose -f src/main/docker/docker-compose.yaml up -d product-ms-database

# if you want to stop the application execute the command below
$ CTRL + C # stop server
$ docker container rm --force product-ms-quarkus-database && docker rmi mongo #stop mongo
```

Run API and mongo both in docker:
```bash
$ bash dockerStart.sh

# if you want to stop the application execute the command below
$ bash dockerStop.sh
```

Now access on your browser: http://localhost:9999 [Tests -> 8888]


docs -> http://localhost:9999/q/doc
Doc

## :thumbsup: How To Contribute

- Make a fork;
- Create a branch with your feature: `git checkout -b my-feature`;
- Commit changes: `git commit -m 'feat: My new feature'`;
- Make a push to your branch: `git push origin my-feature`.

## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/Duduxs/product-ms-quarkus/blob/master/LICENSE) for more information.

---


Made by Eduardo José 😆 Contact me!