README.md 2.04 KB
Newer Older
Stop EcritureInclusive's avatar
Stop EcritureInclusive committed
1 2
# stop-ecriture-inclusive

3
Une extension disponible sur Firefox et Chrome pour corriger l’écriture inclusive d’une page web en temps réel.
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
4 5 6 7 8 9 10

## Français
## Détails techniques

Insaller les dépendances
```bash
 npm install
11
```
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
12

13
Construire l’extension avec Webpack
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
14 15 16 17 18 19
Les fichiers pour Firefox seront dans **/dist/firefox**
Les fichiers pour Chrome seront dans **/dist/chrome**
```bash
npm run build
```

20 21 22 23 24 25 26 27 28 29 30 31
Packager l’extension dans le but de la distribuer ou de la publier pour FIREFOX
Le package zip sera dans **/builds/web-ext-articfacts/**
```bash
npm run package-firefox
```

Packager l’extension dans le but de la distribuer ou de la publier pour CHROME
Le package zip sera dans **/builds/**
```bash
npm run package-chrome
```

Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
32 33 34 35 36
Construire l’extension dans le but de la tester localement avec le live reload :
```bash
npm run watch
```

Stop EcritureInclusive's avatar
Stop EcritureInclusive committed
37
Sur Firefox, vous pouvez tester l’application en lançant la commande suivante depuis le dossier **/dist/firefox**  
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
Plus d’informations sur https://extensionworkshop.com/documentation/develop/web-ext-command-reference/
```bash
web-ext run --verbose
```

Nettoyer le dossier dist :
```bash
npm run clean-dist
```

## English
## Technical Details

Install dependencies
```bash
npm install
```

56
Build the extension with Webpack
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
57 58 59 60 61 62
Files for Firefox will be in **/dist/firefox**
Files for Chrome will be in **/dist/chrome**
```bash
npm run build
```

63 64 65 66 67 68 69 70 71 72 73 74
Package the extension in order to publish and/or distribute for FIREFOX
Le package zip sera dans **/builds/web-ext-articfacts/**
```bash
npm run package-firefox
```

Package the extension in order to publish and/or distribute for CHROME
Le package zip sera dans **/builds/**
```bash
npm run package-chrome
```

Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
75 76 77 78 79
Build the extension to test it locally with live reload:
```bash
npm run watch
```

Stop EcritureInclusive's avatar
Stop EcritureInclusive committed
80
On Firefox, you can test the application using the following command from the folder **/dist/firefox**  
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
81 82 83 84
More infos at https://extensionworkshop.com/documentation/develop/web-ext-command-reference/
```bash
web-ext run --verbose
```
Stop Écriture Inclusive's avatar
Stop Écriture Inclusive committed
85 86 87 88 89

Clean the dist folder :
```bash
npm run clean-dist
```