README.md

Application SpringWEI - API

Tableau de bord développé pour l'application SpringWEI. Il permet de gérer son bungalow et son compte depuis un navigateur web.

Repos en lien avec l'application

• Tableau de bord: https://github.com/raphaelsfeir/spring-wei-dashboard
• Application mobile: https://github.com/raphaelsfeir/spring-wei
• API: https://github.com/raphaelsfeir/spring-wei-api

Développer

Environnement nécessaire

• Node.JS
• Sendgrid pour gérer l'envoi de mails

Installation

git glone git@github.com:raphaelsfeir/spring-wei-api.git
# ou
git clone https://github.com/raphaelsfeir/spring-wei-api.git

cd spring-wei-api
npm install

Ouvrir le fichier src/environments/environments.ts et insérer les informations de développement

Déployer en développement

Lancer npm start. Le tableau de bord est lancé sur l'adresse affichée dans le terminal (en général http://localhost:3000)

Héberger

Cette année nous avons utilisé Heroku pour déployer l'API

API Endpoints

Type	Endpoints	Options	Descriptions
POST	/sendmail	{ "email":"xxx" (string), "prenom": "xxx" (string), "pseudo": "xxx" (string), "password": "xxx" (string) }	Envoi du mail d'inscription avec les informations passées en options
POST	/notifications	{ "id": "xxx" (string), "titre": "xxx" (string), "jour": x (int), "heure": x (int), "minute": xxx (int) }	Prépare la notification identifiée par {id}. Elle sera envoyée {jour} à {heure}h{minute - DELAI=10}
DELETE	/notifications/{id}		Supprime la notification identifiée par {id} en la supprimant des plannifications
GET	notifications		Retourne les notifications qui sont planifiées