https://github.com/ungdev/ua-bouffe-api

API de l'UTT Arena permettant de gérer les commandes de restauration
https://github.com/ungdev/ua-bouffe-api

hacktoberfest

Last synced: 15 days ago
JSON representation

API de l'UTT Arena permettant de gérer les commandes de restauration

• Host: GitHub
• URL: https://github.com/ungdev/ua-bouffe-api
• Owner: ungdev
• License: mit
• Created: 2019-11-04T18:04:48.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-11T14:18:28.000Z (2 months ago)
• Last Synced: 2024-09-11T22:17:22.051Z (2 months ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 604 KB
• Stars: 1
• Watchers: 10
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# UA Bouffe API

[![Build status](https://github.com/ungdev/UA-bouffe-api/actions/workflows/ci.yml/badge.svg)](https://github.com/ungdev/UA-bouffe-api/actions/workflows/ci.yml)

API du microservice [UA Bouffe](https://github.com/ungdev/UA-bouffe)

## Installation

### Prérequis

- NodeJS

- Pnpm

- MySQL

### Base de données

Créer la base de données uabouffe

```

CREATE DATABASE uabouffe CHARACTER SET utf8;

```

### Installation de l'API et des dépendances

Il faut maintenant clone le repo [UA-bouffe](https://github.com/ungdev/UA-bouffe) (avec les submodules) qui contient un jeu de données à mettre dans la DB.

```

git clone https://github.com/ungdev/UA-bouffe-api

cp .env.example .env

pnpm i

```

## Développement

### Démarrer l'API en développement

```

pnpm dev

```

### Avant de commit

Afin de garder une certaine cohérence dans le code, on utilise EsLint et Prettier. Il faut donc bien lint le code avant de commit

```

pnpm lint-fix

```

### Démarrer l'API en production

```

pnpm build

pnpm start

```

### CI/CD

La pipeline de CI/CD est assurée par GitHub Actions.

A chaque push sur master, GitHub Action lint le code, le build et trigger okd pour déployer le code en production ainsi que Slack pour notifier l'avancée de la vérification

Il se passe en moyenne 5 minutes entre un push et un déploiement.

### Diagramme de séquence lors d'une commande

![Diagramme de séquence](./docs/sequence.svg)

### Licence

Le code est sous licence MIT.