4.8 KiB
demarches-simplifiees.fr
Contexte
demarches-simplifiees.fr est un site web conçu afin de répondre au besoin urgent de l'État d'appliquer la directive sur le 100 % dématérialisation pour les démarches administratives.
Comment contribuer ?
demarches-simplifiees.fr est un logiciel libre sous licence AGPL.
Vous souhaitez y apporter des changements ou des améliorations ? Lisez notre guide de contribution.
Installation pour le développement
Dépendances techniques
Tous environnements
- postgresql
Développement
- rbenv : voir https://github.com/rbenv/rbenv-installer#rbenv-installer--doctor-scripts
- Yarn : voir https://yarnpkg.com/en/docs/install
Tests
- Chrome
- chromedriver :
- Mac :
brew cask install chromedriver - Linux : voir https://sites.google.com/a/chromium.org/chromedriver/downloads
- Mac :
Création des rôles de la base de données
Les informations nécessaire à l'initialisation de la base doivent être pré-configurées à la main grâce à la procédure suivante :
su - postgres
psql
> create user tps_development with password 'tps_development' superuser;
> create user tps_test with password 'tps_test' superuser;
> \q
Initialisation de l'environnement de développement
Sous Ubuntu, certains packages doivent être installés au préalable :
sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev libcurl4-gnutls-dev zlib1g-dev
Afin d'initialiser l'environnement de développement, exécutez la commande suivante :
bin/setup
Lancement de l'application
On lance le serveur d'application ainsi :
bin/dev
L'application tourne alors à l'adresse http://localhost:3000 en parralel avec un worker pour les jobs et le bundler vitejs.
Utilisateurs de test
En local, un utilisateur de test est créé automatiquement, avec les identifiants test@exemple.fr/this is a very complicated password !. (voir db/seeds.rb)
Programmation des tâches récurrentes
rails jobs:schedule
Voir les emails envoyés en local
Ouvrez la page http://localhost:3000/letter_opener.
Mise à jour de l'application
Pour mettre à jour votre environnement de développement, installer les nouvelles dépendances et faire jouer les migrations, exécutez :
bin/update
Exécution des tests (RSpec)
Les tests ont besoin de leur propre base de données et certains d'entre eux utilisent Selenium pour s'exécuter dans un navigateur. N'oubliez pas de créer la base de test et d'installer chrome et chromedriver pour exécuter tous les tests.
Pour exécuter les tests de l'application, plusieurs possibilités :
-
Lancer tous les tests
bin/rake spec bin/rspec -
Lancer un test en particulier
bin/rake spec SPEC=file_path/file_name_spec.rb:line_number bin/rspec file_path/file_name_spec.rb:line_number -
Lancer tous les tests d'un fichier
bin/rake spec SPEC=file_path/file_name_spec.rb bin/rspec file_path/file_name_spec.rb -
Relancer uniquement les tests qui ont échoué précédemment
bin/rspec --only-failures -
Lancer un ou des tests systèmes avec un browser
NO_HEADLESS=1 bin/rspec spec/system
Ajout de taches à exécuter au déploiement
rails generate after_party:task task_name
Linting
Le projet utilise plusieurs linters pour vérifier la lisibilité et la qualité du code.
- Faire tourner tous les linters :
bin/rake lint - Vérifier l'état des traductions :
bundle exec i18n-tasks health - AccessLint tourne automatiquement sur les PRs
Régénérer les binstubs
bundle binstub railties --force
bin/rake rails:update:bin
Déploiement
Voir les notes de déploiement dans DEPLOYMENT.md
Tâches courantes
Tâches de gestion des comptes super-admin
Des tâches de gestion des comptes super-admin sont prévues dans le namespace superadmin.
Pour les lister : bin/rake -D superadmin:.
Tâches d’aide au support
Des tâches d’aide au support sont prévues dans le namespace support.
Pour les lister : bin/rake -D support:.
Compatibilité navigateurs
L'application gère les navigateurs récents, parmis lequels Firefox, Chrome, Safari et Edge (voir config/initializers/browser.rb).
La compatibilité est testée par Browserstack.
Performance
Nous utilisons Skylight pour suivre les performances de notre application.