jabibamman / BiblioNest

Angular NestJS to manage your books and what book you want to read

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

đź“– BiblioNest

wakatime

BiblioNest

BiblioNest est une application web qui vous permet de gérer votre bibliothèque personnelle. C'est un projet gratuit et open source, et il est disponible sur GitHub.

  • Description de notre projet :

  • Outils utilisĂ©s : Prisma, NestJS, Angular, Docker, Postman, DBeaver, Bootstrap, Google API

Nous avons utilisé prisma, postman et dbeaver pour le backend, et bootstrap, google api pour le frontend.

Nous avons aussi utilisé docker, prettier et eslint et le bind-mount de docker pour tout le projet.

  • Languages utilisĂ©s :

Nous avons utilisé du NestJS pour le backend, du Angular pour le frontend.

Versionning :

Nous avons décidé d'utiliser le "Github flow" car nous pensons que cela correspond mieux à un projet où nous sommes plusieurs et où on travaille pendant plusieurs mois en se dispatchant les fonctionnalitées et en faisant des pull request une fois qu'elles sont testées et fonctionnelles.

Fonctionnalités de l'application :

  • DiffĂ©rents choix effectuĂ©s :
    • Nous avons dĂ©cidĂ©s de laisser l'api de Google Book remplir les champs de l'application quand l'utisateur ne les remplis pas, car cela permet de gagner du temps et de ne pas avoir Ă  remplir les champs manuellement.
    • Nous avons utilisĂ© un système de pagination pour la liste des livres, car cela permet de ne pas avoir Ă  charger tous les livres d'un coup, et de ne pas avoir Ă  faire des requĂŞtes trop lourdes. (semi-fonctionnel)
    • Un système de recherche a Ă©tĂ© mis en place pour la liste des livres, car cela permet de ne pas avoir Ă  chercher un livre parmi une liste trop longue.
    • On a utilisĂ© prisma pour la base de donnĂ©es, car cela permet de gagner du temps et de ne pas avoir Ă  crĂ©er les requĂŞtes manuellement.
    • Une page profil utilisateur a Ă©tĂ© crĂ©Ă©e, car cela permet de voir les informations de l'utilisateur.

Contribuer :

  • DiffĂ©rents choix effectuĂ©s :

DĂ©ploiements :

  • DiffĂ©rents choix effectuĂ©s :
    • Pour deployer avec docker-compose il faudra faire
      • npm run start pour initialiser le .env dans le backend
    • ensuite soit:
      • la prod: (biblionest-front-prod, biblionest-back, et db) :
        • docker-compose up db biblionest-front-prod biblionest-back
      • le dev: (biblionest-front, biblionest-back, et db) :
        • docker-compose up db biblionest-front biblionest-back

Tests Logociels :

Nous n'avons pas utiliser de tests unitaires et fonctionnels par manque de temps, mais nous avons testé chaques fonctionnalitées à la main pour au moins valider les fonctions primaires de l'application.

About

Angular NestJS to manage your books and what book you want to read


Languages

Language:TypeScript 69.3%Language:HTML 25.4%Language:CSS 2.6%Language:JavaScript 1.9%Language:SCSS 0.5%Language:Dockerfile 0.3%