Merge pull request #81 from sgmap/readme

Update the Readme
This commit is contained in:
Mathieu Magnin 2017-04-11 10:26:29 +02:00 committed by GitHub
commit 0038fdad52

View file

@ -1,14 +1,19 @@
# TPS - TéléProcédure Simplifié # TPS - TéléProcédure Simplifiée
## Context ## Context
TéléProcédure Simplifiée, ou TPS pour les intimes, est une plateforme 100% web et 0% email, conçue afin de répondre au besoin urgent de l'État d'appliquer la directive sur le 100% démat' à l'horizon 2018 pour les démarches administratives. TéléProcédure Simplifiée, ou TPS pour les intimes, est une plateforme 100 % web et 0 % email, conçue afin de répondre au besoin urgent de l'État d'appliquer la directive sur le 100 % démat' à l'horizon 2018 pour les démarches administratives.
## Technologies utilisées ## Dépendances
Ruby : 2.3.1 ### Tous environnements
Rails : 5.0.0.1
- postgresql
### Tests
- PhantomJS
## Initialisation de l'environnement de développement ## Initialisation de l'environnement de développement
@ -20,11 +25,7 @@ Afin d'initialiser l'environnement de développement, éxécutez la commande sui
## Création de la base de données ## Création de la base de données
L'application utilise une base de donnée Postgresql. Pour en installer une, utilisez la commande suivante : Les informations nécessaire à l'initialisation de la base doivent être pré-configurées à la main grâce à la procédure suivante :
sudo apt-get install postgresql
Les informations nécessaire à l'initialisation de la base doivent être pré-configurer à la main grâce à la procédure suivante :
su - postgres su - postgres
psql psql
@ -32,21 +33,15 @@ Les informations nécessaire à l'initialisation de la base doivent être pré-c
> create user tps_test with password 'tps_test' superuser; > create user tps_test with password 'tps_test' superuser;
> \q > \q
Afin de générer la BDD de l'application, il est nécessaire d'éxécuter les commandes suivantes : Afin de générer la BDD de l'application, il est nécessaire d'éxécuter les commandes suivantes :
rake db:create db:schema:load db:migrate rake db:create db:schema:load db:migrate
rake db:create db:schema:load db:migrate RAILS_ENV=test rake db:create db:schema:load db:migrate RAILS_ENV=test
## Installation de Phantom JS ## Exécution des tests (RSpec)
Installer PhantomJS qui est utilisé par les tests automatisés de l'application. Pour exécuter les tests de l'application, plusieurs possibilités :
## Exécution des tests (Rspec)
Pour éxécuter les tests de l'application, plusieurs possibilités :
- Lancer tous les tests - Lancer tous les tests
@ -67,7 +62,7 @@ Pour éxécuter les tests de l'application, plusieurs possibilités :
- Linter les fichiers HAML : `bundle exec haml-lint app/views/` - Linter les fichiers HAML : `bundle exec haml-lint app/views/`
## Regénérer les binstubs ## Régénérer les binstubs
bundle binstub railties --force bundle binstub railties --force
rake rails:update:bin rake rails:update:bin