🃏clean-code-deck 🃏

Description ?

This project is related to this description :

This game is a game of cards to collect, evolve and with which players can face the cards other players. These cards are heroes, each with their specificities and rarity.

The goal of this application it's to learn how to build a Hexagonal Architecture with SOLID principles and base code tested.

---

Requirements ?

Install :

• Java17
  • macOS : execute the command in the terminal brew install openjdk@17
  • Windows : see the tutorial
• IntelliJ ( IDEA)
• Maven3
  • macOS : execute the command in the terminal brew install maven
  • Windows : see the tutorial
• Docker (for Mongo Database 🥭)
• Postman (for test REST API)

---

How to use ?

Before

• Create an external volume on Docker and name it "clean-code-deck".

Run

docker-compose up -d

This command will bring the database up on a local environment.

After that you can run the Spring Application on IntelliJ or with this command mvn spring-boot:run! 🚀

Check Api

Hit this url on a Web browser to see the API endpoint : http://localhost:8080/swagger-ui/ 🙌🏻

After (Stop)

• Stop the Spring Application on IntelliJ.
• docker-compose stop

Be sure that you don't use docker-compose down to not clear the volume of the database and clear the data inside.

---

Contributing

• MARLEIX Noé -> noeoxycode
• MOUCHON Sacha -> cawa-dev

---

License

MIT