README.md

Learn(Err) API V1

Introduction

Projet d'apothéose née d'une collaboration entre 4 personnes : 2 front-end, 2 back-end

Equipe front-end : Julien Goletto & Pierre Arragain

Equipe back-end : Frédéric Basler & Helene Nguyen

---

Technologies

Pour le développement de l'API, nous travaillerons avec l'environnement NodeJS ainsi que son framework Express.

Nous allons utiliser Sqitch pour le versioning et la migration de la bases de données.

Pour ce qui est de la gestion de notre base de données (SBGD) notre décision c'est porté sur PostgreSQL.

Les test au sein de notre API seront effectués par Jest.

Création de toute la documentation de notre API avec l'aide de Swagger.

---

Sommaire

1. Etude du projet
2. Base de données
3. Initialisation
4. Serveur
5. Schéma
6. Error Logger
7. Error Handler
8. Authentification
9. DataMapper
10. Routes
11. Swagger Docs
12. Controllers
13. Rest Client

---

Sources

Sources technologies

• NodeJS
• Express
• SQL
• Node-PostgreSQL
• PostgreSQL
• Sqitch
• Jest
• Swagger

Sources NPM (Node Package Manager)

• Dotenv

• Pg

• Express

• Express-session

• JsonWebToken

• Helmet

• Joi

• Bcrypt

• swagger-jsdoc

• swagger-ui-express

• Dépendances dev :

  • Debug
  • Bad Words List french
  • @shiroi-shi/techstack
  • @faker-js/faker
  • Jest

Extensions VSCODE et logiciel

• Rest Client
• Insomnia
• Database Client
• LiveShare

Sources SQL/PostgreSQL

• Boundaries

Sources Javascript

• Destructuring