demarches-normaliennes/README.md

195 lines
6.7 KiB
Markdown
Raw Normal View History

2018-03-30 07:42:09 +02:00
# demarches-simplifiees.fr
2015-10-13 15:53:07 +02:00
## Contexte
2015-10-13 15:53:07 +02:00
2018-12-06 15:56:40 +01:00
[demarches-simplifiees.fr](https://www.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.
2015-10-13 15:53:07 +02:00
2018-12-06 15:56:40 +01:00
## Comment contribuer ?
2018-12-06 15:56:40 +01:00
demarches-simplifiees.fr est un [logiciel libre](https://fr.wikipedia.org/wiki/Logiciel_libre) sous licence AGPL.
Vous souhaitez y apporter des changements ou des améliorations ? Lisez notre [guide de contribution](CONTRIBUTING.md).
## Installation pour le développement
### Dépendances techniques
#### Tous environnements
- postgresql
- imagemagick et gsfonts pour générer les filigranes sur les titres d'identité ou générer des minitiatures d'images.
> [!WARNING]
> Pensez à restreindre la policy d'ImageMagick pour bloquer l'exploitation d'images malveillantes.
> La configuration par défaut est généralement insuffisante pour des images provenant du web.
> Par exemple sous debian/ubuntu dans `/etc/ImageMagick-6/policy.xml` :
```xml
<!-- en plus de la policy par défaut, ajoutez à la fin du fichier -->
<policymap>
<policy domain="coder" rights="none" pattern="*"/>
<policy domain="coder" rights="read | write" pattern="{JPG,JPEG,PNG,JSON}"/>
<policy domain="module" rights="none" pattern="{MSL,MVG,PS,SVG,URL,XPS}"/>
</policymap>
```
Nous sommes en cours de migration de `delayed_job` vers `sidekiq` pour le traitement des jobs asynchrones.
Pour faire tourner sidekiq, vous aurez besoin de :
2023-09-26 12:31:26 +02:00
- redis
2018-12-06 15:56:40 +01:00
#### Développement
2017-05-04 12:25:08 +02:00
- rbenv : voir https://github.com/rbenv/rbenv-installer#rbenv-installer--doctor-scripts
2018-09-03 14:20:32 +02:00
- Yarn : voir https://yarnpkg.com/en/docs/install
2018-12-06 15:56:40 +01:00
#### Tests
- Chrome
2018-01-16 17:58:53 +01:00
- chromedriver :
* Mac : `brew install chromedriver`
* Linux : voir https://developer.chrome.com/blog/chrome-for-testing
Si l'emplacement d'installation de Chrome n'est pas standard, ou que vous utilisez Brave ou Chromium à la place,
il peut être nécessaire d'overrider pour votre machine le path vers le binaire Chrome, par exemple :
```ruby
# create file spec/support/spec_config.local.rb
Selenium::WebDriver::Chrome.path = "/Applications/Brave Browser.app/Contents/MacOS/Brave Browser"
# Must exactly match the browser version
Webdrivers::Chromedriver.required_version = "103.0.5060.53"
```
Il est également possible de faire une installation et mise à jour automatique lors de l'exécution de `bin/update` en définissant la variable d'environnement `UPDATE_WEBDRIVER`. Les binaires seront installés dans le repertoire `~/.local/bin/` qui doit être rajouté manuellement dans le path.
2018-12-06 15:56:40 +01:00
### Création des rôles de la base de données
2015-10-13 15:53:07 +02:00
2017-04-04 13:52:17 +02:00
Les informations nécessaire à l'initialisation de la base doivent être pré-configurées à la main grâce à la procédure suivante :
2015-10-13 15:53:07 +02:00
su - postgres
psql
> create user tps_development with password 'tps_development' superuser;
> create user tps_test with password 'tps_test' superuser;
2015-10-13 15:53:07 +02:00
> \q
2017-01-16 18:16:35 +01:00
2019-11-05 17:56:23 +01:00
2018-12-06 15:56:40 +01:00
### Initialisation de l'environnement de développement
2015-10-13 15:53:07 +02:00
2019-11-05 17:56:23 +01:00
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
2019-11-05 17:56:23 +01:00
Afin d'initialiser l'environnement de développement, exécutez la commande suivante :
2018-08-21 12:16:55 +02:00
bin/setup
2018-12-06 15:56:40 +01:00
### Lancement de l'application
2017-05-04 12:25:26 +02:00
On lance le serveur d'application ainsi :
2017-05-04 12:25:26 +02:00
2022-06-17 12:36:21 +02:00
bin/dev
2022-09-30 03:10:08 +02:00
L'application tourne alors à l'adresse `http://localhost:3000` avec en parallèle 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](https://github.com/betagouv/demarches-simplifiees.fr/blob/dev/db/seeds.rb))
2020-03-28 16:45:16 +01:00
### Programmation des tâches récurrentes
rails jobs:schedule
2017-05-04 12:25:26 +02:00
2018-12-06 15:56:40 +01:00
### Voir les emails envoyés en local
2018-10-18 15:06:18 +02:00
Ouvrez la page [http://localhost:3000/letter_opener](http://localhost:3000/letter_opener).
2018-10-18 15:06:18 +02:00
2018-12-06 15:56:40 +01:00
### 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
2018-12-06 15:56:40 +01:00
### Exécution des tests (RSpec)
2015-10-13 15:53:07 +02:00
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.
2017-04-04 13:52:17 +02:00
Pour exécuter les tests de l'application, plusieurs possibilités :
2015-10-13 15:53:07 +02:00
- Lancer tous les tests
bin/rake spec
bin/rspec
2015-10-13 15:53:07 +02:00
- 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
2015-10-13 15:53:07 +02:00
- 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
2015-10-13 15:53:07 +02:00
- 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
- Afficher les logs js en error issus de la console du navigateur `console.error('coucou')`
JS_LOG=error bin/rspec spec/system
- Augmenter la latence lors de tests end2end pour déceler des bugs récalcitrants
MAKE_IT_SLOW=1 bin/rspec spec/system
2018-12-06 15:56:40 +01:00
### Ajout de taches à exécuter au déploiement
2018-07-18 15:45:23 +02:00
rails generate after_party:task task_name
2018-12-06 15:56:40 +01:00
### Linting
2018-12-21 15:20:49 +01:00
Le projet utilise plusieurs linters pour vérifier la lisibilité et la qualité du code.
- Faire tourner tous les linters : `bin/rake lint`
2020-09-04 10:45:50 +02:00
- Vérifier l'état des traductions : `bundle exec i18n-tasks health`
- [AccessLint](http://accesslint.com/) tourne automatiquement sur les PRs
2015-10-13 15:53:07 +02:00
2018-12-06 15:56:40 +01:00
### Régénérer les binstubs
bundle binstub railties --force
bin/rake rails:update:bin
2017-08-21 14:44:29 +02:00
## Déploiement
2022-02-22 09:16:03 +01:00
Voir les notes de déploiement dans [DEPLOYMENT.md](doc/DEPLOYMENT.md)
2017-08-21 14:44:29 +02:00
2018-12-06 15:56:40 +01:00
## Tâches courantes
2018-01-03 11:45:19 +01:00
### Tâches de gestion des comptes super-admin
2018-01-03 11:45:19 +01:00
Des tâches de gestion des comptes super-admin sont prévues dans le namespace `superadmin`.
Pour les lister : `bin/rake -D superadmin:`.
2018-12-06 15:56:40 +01:00
### Tâches daide au support
Des tâches daide 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`).
2018-11-27 11:21:12 +01:00
La compatibilité est testée par Browserstack.<br>[<img src="app/assets/images/browserstack-logo-600x315.png" width="200">](https://www.browserstack.com/)
2018-02-26 19:19:01 +01:00
## Performance
[![View performance data on Skylight](https://badges.skylight.io/status/zAvWTaqO0mu1.svg)](https://oss.skylight.io/app/applications/zAvWTaqO0mu1)
Nous utilisons Skylight pour suivre les performances de notre application.