_ ____ ___ _ _
/ \ | _ \_ _| | | (_)_ ___ __ ___ ___
/ _ \ | |_) | | | | | \ \ / / '__/ _ \/ __|
/ ___ \| __/| | | |___| |\ V /| | | __/\__ \
/_/ \_\_| |___| |_____|_| \_/ |_| \___||___/
Api-Livres est une API permettant de lister l'ensemble des livres existants et de les retrouver par rapport à leur emplacement à un certain étage dans une bibliothèque.
Pour ce faire, vous devrez commencer par cloner ce repo git. Avant d'ensuite exécuter les commandes ci-dessous.
npm install # Installer les librairies
cp .env-example .env # Crée le fichier dotenv à *CONFIGURER*
Ce projet vous permet également d'utiliser Docker pour la base de données, vous aurez simplement à modifier les informations présentes dans le "docker-compose.yml" puis à faire la commande suivante
docker compose up -d # Permet de lancer docker en détaché
Pour les données de la base, vous les avez dans le "/data-db/database.txt" avec les tables.
Une fois toutes les étapes réalisées, vous pouvez démarrer le Projet, pensez tout de même à ajouter des données !
npm run swagger # Actualise la documentation et lance le serveur
npm start # Lance le serveur API
Pour voir les autres routes, référez-vous à la documentation (/docs)
- Livres "/api/books" > API des livres
- Bibliothèques "/api/bookshelf" > API des bibliothèques