Logo

Personal Library Manager API

This API is designed to help you list all your books.

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
## About The Project This API helps you to manage your books. You can add new ones, list yours, loan or borrow some others.

(back to top)

### Built With * ![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white) * ![Quarkus](https://img.shields.io/badge/quarkus-grey.svg?style=for-the-badge&logo=quarkus) * ![MongoDB](https://img.shields.io/badge/mongodb-darkgreen.svg?style=for-the-badge&logo=mongodb&logoColor=white) * ![PostgreSQL](https://img.shields.io/badge/postgresql-blue.svg?style=for-the-badge&logo=postgresql&logoColor=white)

(back to top)

## Getting Started To get a local copy up and running follow these simple example steps. ### Prerequisites * Java (version >= 17) * Maven (version == 3.8.4) * MongoDB (version == 7) * Postgres (version == 14) * IntelliJ Ultimate Edition to use included tests files ### Local Installation 1. Clone the repo ```sh git clone TODO ``` 2. Create a local `.env` file at your project root and fill these variables ```properties MONGODB_CONNECTION_STRING= MONGODB_DATABASE_NAME= PG_USERNAME= PG_PASSWORD= PG_HOST= ``` 3. Build a local version of the application ``` mvn clean package ``` It will generate your compiled application into target/quarkus-app directory and your Swagger documentation files into the swagger directory. 4. Run tests locally and publish sonar reports ``` mvn verify sonar:sonar ```

(back to top)

## Usage _For more examples, please refer to the Swagger [Documentation](https://codefirst.iut.uca.fr/swagger?url=/containers/camillepetitalot-cicd-java-backend/swagger/)_

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge [contributors-url]: https://github.com/github_username/repo_name/graphs/contributors [forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge [forks-url]: https://github.com/github_username/repo_name/network/members [stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge [stars-url]: https://github.com/github_username/repo_name/stargazers [issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge [issues-url]: https://github.com/github_username/repo_name/issues [license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge [license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/linkedin_username [product-screenshot]: images/library.png [Java]: https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white [Next-url]: https://nextjs.org/ [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB [React-url]: https://reactjs.org/ [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D [Vue-url]: https://vuejs.org/ [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white [Angular-url]: https://angular.io/ [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00 [Svelte-url]: https://svelte.dev/ [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white [Laravel-url]: https://laravel.com [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white [Bootstrap-url]: https://getbootstrap.com [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white [JQuery-url]: https://jquery.com