You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
189 lines
6.1 KiB
189 lines
6.1 KiB
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
|
|
<a name="readme-top"></a>
|
|
<!--
|
|
*** Thanks for checking out the Best-README-Template. If you have a suggestion
|
|
*** that would make this better, please fork the repo and create a pull request
|
|
*** or simply open an issue with the tag "enhancement".
|
|
*** Don't forget to give the project a star!
|
|
*** Thanks again! Now go create something AMAZING! :D
|
|
-->
|
|
|
|
<!-- PROJECT SHIELDS -->
|
|
<!--
|
|
*** I'm using markdown "reference style" links for readability.
|
|
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
*** See the bottom of this document for the declaration of the reference variables
|
|
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
-->
|
|
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<div align="center">
|
|
<img src="images/library.png" alt="Logo" width="240" height="150">
|
|
|
|
<h3 align="center">Personal Library Manager API</h3>
|
|
|
|
<p align="center">
|
|
This API is designed to help you list all your books.
|
|
<br />
|
|
<br />
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
<ol>
|
|
<li>
|
|
<a href="#about-the-project">About The Project</a>
|
|
<ul>
|
|
<li><a href="#built-with">Built With</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="#getting-started">Getting Started</a>
|
|
<ul>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#installation">Installation</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#usage">Usage</a></li>
|
|
</ol>
|
|
</details>
|
|
|
|
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
|
|
## About The Project
|
|
|
|
This API helps you to manage your books. You can add new ones, list yours, loan or borrow some others.
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
### Built With
|
|
|
|
* 
|
|
* 
|
|
* 
|
|
* 
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- GETTING STARTED -->
|
|
|
|
## 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=<TO_FILL>
|
|
MONGODB_DATABASE_NAME=<TO_FILL>
|
|
PG_USERNAME=<TO_FILL>
|
|
PG_PASSWORD=<TO_FILL>
|
|
PG_HOST=<TO_FILL>
|
|
```
|
|
3. Build a local version of the application
|
|
```
|
|
mvn clean package
|
|
```
|
|
It will generate your compiled application into <span style="color:red">target/quarkus-app</span> directory and your Swagger documentation files into the <span style="color:red">swagger</span> directory.
|
|
4. Run tests locally and publish sonar reports
|
|
```
|
|
mvn verify sonar:sonar
|
|
```
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- USAGE EXAMPLES -->
|
|
|
|
## Usage
|
|
|
|
_For more examples, please refer to the Swagger [Documentation](https://codefirst.iut.uca.fr/swagger?url=/containers/camillepetitalot-cicd-java-backend/swagger/)_
|
|
|
|
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
|
|
[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 |