https://github.com/ungdev/broadway-api

API du site de Broadway UTT
https://github.com/ungdev/broadway-api

Last synced: 12 months ago
JSON representation

API du site de Broadway UTT

• Host: GitHub
• URL: https://github.com/ungdev/broadway-api
• Owner: ungdev
• License: mit
• Created: 2020-02-08T11:26:09.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-06-01T11:06:40.000Z (almost 6 years ago)
• Last Synced: 2025-04-09T05:42:46.095Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 1.46 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Broadway API

![travis](https://travis-ci.org/ungdev/broadway-api.svg?branch=master)

API du site de l'assocation Broadway UTT

## Installation

### Prérequis

- NodeJS

- Yarn

- MySQL

### Base de données

Créer la base de données broadway

```

CREATE DATABASE broadway CHARACTER SET utf8;

```

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

```

git clone https://github.com/ungdev/broadway-api

cp .env.example .env

yarn

yarn seed

```

## Développement

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

```

yarn 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

```

yarn lint-fix

```

### Démarrer l'API en production

```

yarn build

yarn start

```

### Documentation

Le modèle de la base de donnée est situé [ici](https://dbdiagram.io/d/5e24e0719e76504e0ef06dd9)

### Licence

Le code est sous licence MIT.