EricB2A / backend

API rails utilisée pour la gestion des informations de l'application Note-thing

Backend

Commencer 🏁

Pré-requis

• Docker engine : 20.10.*
• Docker compose
  • NOTE: docker compose est inclus dans les installation de l'engine sur Windows et MacOS.

Installation

1. Cloner le répository

git clone https://github.com/Note-thing/backend && cd backend

2. Lancer le conteneur Docker

docker-compose up

3. Créez un fichier .env, et mettez y la variable d'environnement JWT_SECRET='example'. Vous pouvez vous inspirer de .env.example ou le remplacer !

mv .env.example .env

Afin d'envoyer des mails de reset de mot de passe, nous utilisons gmail. Veillez à avoir une configuration gmail présente dans le .env, via les variables EMAIl=[e-mail] et EMAIL_PASSWORD=password.

4. Allez à l'adresse localhost:3001 et vous voilà prêt à contribuer 😎.

Se connecter au container Docker

docker exec -it backend_app_1 /bin/bash

Vous pouvez ensuite intéragir avec rails via le docker.

Quelques commandes utiles

Créer la db

rails db:create

Lancer les migrations

rails db:migrate

Lancer les seeds

rails db:seed

Lancer le serveur

rails s

Afficher les routes disponible

rake routes