|
@@ -1,24 +1,16 @@
|
1
|
|
-# README
|
|
1
|
+# Registra
|
|
2
|
+## Rails API
|
2
|
3
|
|
3
|
|
-This README would normally document whatever steps are necessary to get the
|
4
|
|
-application up and running.
|
|
4
|
+Ruby 3.0.1 // Rails 6.1.3.1
|
5
|
5
|
|
6
|
|
-Things you may want to cover:
|
|
6
|
+Voir [cet article](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04) pour installer Ruby avec Rbenv, un gestionnaire de version pour Ruby.
|
|
7
|
+Installer rails : `gem install rails -v 6.1.3.1`
|
7
|
8
|
|
8
|
|
-* Ruby version
|
|
9
|
+### 1. Installation
|
|
10
|
+1. `bundle install`
|
|
11
|
+2. `rails db:migrate` (et `rails db:seed` pour peupler la db avec des données factices, si nécessaire)
|
|
12
|
+3. `rails server` pour lancer un serveur local sur le port 3000
|
9
|
13
|
|
10
|
|
-* System dependencies
|
|
14
|
+### 2. Endpoints
|
|
15
|
+La commande `rails routes` fournie l'ensemble des endpoints et requêtes HTTP disponibles. L'ensemble des requêtes se font sur la base : localhost:3000/api/v1.
|
11
|
16
|
|
12
|
|
-* Configuration
|
13
|
|
-
|
14
|
|
-* Database creation
|
15
|
|
-
|
16
|
|
-* Database initialization
|
17
|
|
-
|
18
|
|
-* How to run the test suite
|
19
|
|
-
|
20
|
|
-* Services (job queues, cache servers, search engines, etc.)
|
21
|
|
-
|
22
|
|
-* Deployment instructions
|
23
|
|
-
|
24
|
|
-* ...
|