/backend

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

Primary LanguageRubyApache License 2.0Apache-2.0

Backend

Commencer 🏁

Pré-requis

Installation

  1. Cloner le répository
git clone https://github.com/Note-thing/backend && cd backend
  1. Lancer le conteneur Docker
docker-compose up
  1. 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=example@gmail.com et EMAIL_PASSWORD=password.

  1. 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