Added readme

master
Cemal Odabasioglu 2024-02-07 17:23:01 +01:00
parent 50452658cb
commit dde51e73cd
3 changed files with 39 additions and 8 deletions

View File

@ -1 +1,29 @@
# iut-project-cemal # Movie Library API
Cette API permet de gérer une bibliothèque de films.
## Configuration requise
- Node.js (v20 recommandé)
- RabbitMQ (v3.8 recommandé)
- Serveur de messagerie SMTP (Etheral recommandé)
## Installation
1. Clonez ce dépôt : https://git.odabasioglu.fr/Cemal/iut-hapi
2. Installez les dépendances : `npm install`
3. Créez un fichier `.env` à la racine du projet et renseignez les variables d'environnement suivantes :
- `EMAIL_USER` : le port sur lequel le serveur doit écouter
- `EMAIL_PASSWORD` : l'URL de votre serveur RabbitMQ
- `EMAIL_FROM` : l'adresse de votre serveur SMTP
- `EMAIL_PORT` : le port de votre serveur SMTP
- `EMAIL_HOST` : l'identifiant de votre serveur SMTP
- `EMAIL_PASS` : le mot de passe de votre serveur SMTP
4. Exécutez les migrations de la base de données :
- `knex migrate:latest`
5. Démarrez le conteneur RabbitMQ : `docker run -it --rm --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3.12-management`
6. Démarrez le conteneur MySQL : `docker run --name hapi-mysql -e MYSQL_ROOT_PASSWORD=hapi -e MYSQL_DATABASE=user mysql --default-authentication-plugin=mysql_native_password -d mysql:8`
7. Démarrez le serveur : `node server/index.js`
8. Le serveur est maintenant accessible à l'adresse `http://localhost:4000`
9. Vous pouvez accéder à la documentation de l'API à l'adresse `http://localhost:4000/documentation`

View File

@ -7,11 +7,11 @@ module.exports = class EmailService extends Service {
createTransporter() { createTransporter() {
// Crée un transporteur SMTP réutilisable // Crée un transporteur SMTP réutilisable
return nodemailer.createTransport({ return nodemailer.createTransport({
host: 'smtp.ethereal.email', host: process.env.EMAIL_HOST,
port: 587, port: process.env.EMAIL_PORT,
auth: { auth: {
user: 'adeline.ondricka5@ethereal.email', user: process.env.EMAIL_FROM,
pass: 'B4khRtXZPNqtr58bAu' pass: process.env.EMAIL_PASS
} }
}); });
} }

View File

@ -1,6 +1,9 @@
# Rename me to .env then fill me with runtime configuration and credentials # Rename me to .env then fill me with runtime configuration and credentials
# Just don't try to check me into your repo :) # Just don't try to check me into your repo :)
# Confused? See https://github.com/motdotla/dotenv # Confused? See https://github.com/motdotla/dotenv
# EMAIL_USER=
# e.g. EMAIL_PASSWORD=
# PORT=4000 EMAIL_FROM=
EMAIL_PORT=
EMAIL_HOST=
EMAIL_PASS=