Skip to content

Commit

Permalink
Merge pull request #125 from dnum-mi/plegaud-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
laruiss committed Nov 8, 2021
2 parents 59924db + 9fb73ae commit 4665ea2
Showing 1 changed file with 89 additions and 4 deletions.
93 changes: 89 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,107 @@
[Système de Design Français](https://www.systeme-de-design.gouv.fr/) (ou DSFR) sous forme de bibliothèque
de composants. Il peut s'utiliser facilement en tant que plugin.

## Pré-requis

- npm : version 7 minimum
- Node.js : version 16 minimum

### Installation des pré-requis (testé sous Ubuntu 20.04)

Suivez la procédure suivante en lançant les commandes détaillées ci-dessous :

1. Mise à jour des dépôts :

```shell
sudo apt update
```

2. Installer `Node.js` :

```shell
sudo apt install nodejs
```

3. Vérifier la version de `npm` (7 ou supérieur) :

```shell
npm --version
```

4. Installer `nvm` (Node Version Manager) :

Avec la commande curl :

```shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
```

Ou avec la commande wget :

```shell
wget -q0- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
```

5. Fermer et rouvrir un terminal, ou bien taper la commande suivante dans tous les terminaux déjà ouverts :

```shell
source ~/.bashrc
```

6. Vérifier la version de NVM installée :

```shell
nvm --version
```

7. Vérifier qu'on pourra bien installer la version de nodejs avec la commande suivante, qui donne la liste des versions nodejs installables :

```shell
nvm ls-remote
```

8. Installer la version de nvm voulue :

```shell
nvm install <version>
```

exemple :

```shell
nvm install 16
```

9. Vérifier la version de `npm` (7 ou supérieur) :

```shell
npm --version
```

Remarque : certaines commandes peuvent demander un temps d'exécution assez conséquent (plusieurs minutes).

## Installer la bibliothèque

```shell
npm install @laruiss/vue-dsfr@beta
```

N.B. : le `@beta` est important pour avoir la dernière version.
---

**Note :**

Le **`@beta`** est très important pour avoir la dernière version.

---

## Utiliser la bibliothèque en tant le plugin Vue 3
## Utiliser la bibliothèque en tant que plugin Vue 3

```js
import { createApp } from 'vue'
import App from './App.vue'
import VueDsfr from '@laruiss/vue-dsfr' // Import (par défaut) de la bibliothèque

import '@laruiss/vue-dsfr/dist/vue-dsfr-fonts.css' // Import des polices
import '@laruiss/vue-dsfr/dist/vue-dsfr-fonts.css' // Import de toutes les polices
import '@laruiss/vue-dsfr/dist/vue-dsfr.css' // Import des styles globaux

const app = createApp(App)
Expand All @@ -43,4 +128,4 @@ Et ensuite, les composants sont utilisables directement dans les composants de l

# Plus d'informations

Veuillez consulter [le site officiel](https://vue-dsfr.netlify.app/) pour plus d'information.
Veuillez consulter [le site officiel](https://vue-dsfr.netlify.app/) pour plus d'informations.

0 comments on commit 4665ea2

Please sign in to comment.