Skip to content

Commit

Permalink
mise à jour du read-me
Browse files Browse the repository at this point in the history
  • Loading branch information
jengelaere committed Aug 23, 2023
1 parent cff7401 commit 05388b1
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 23 deletions.
17 changes: 10 additions & 7 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,19 @@ knitr::opts_chunk$set(

# {shinygouv}

Le package {shinygouv} permet d'utiliser le [`Système de Design de l'Etat` (DSFR)](https://www.systeme-de-design.gouv.fr/) dans vos applications Shiny.
Le package `{shinygouv}` permet d'utiliser le [`Système de Design de l'Etat` (DSFR)](https://www.systeme-de-design.gouv.fr/) dans vos applications Shiny.

Cela leur donnera ce genre de look :

![](man/figures/look_dsfr.png)

Il s'installe depuis github :

```{r}
```{r, eval=FALSE}
# install.packages("remotes")
remotes::install_github("spyrales/shinygouv")
```


# Comment utiliser le package

Le package s'utilise comme {shiny}. Voici un exemple minimaliste pour la partie UI:
Expand Down Expand Up @@ -53,18 +56,18 @@ shinyApp(
)
```


# Visualiser une application de démonstration comprenant les composants déjà implémentés:

[shinygouv-demo](https://ssm-ecologie.shinyapps.io/shinygouv-demo/)
[shinygouv-demo version de dev](https://ssm-ecologie.shinyapps.io/shinygouv-demo-dev/)

[shinygouv-demo, version en cours de developpement](https://ssm-ecologie.shinyapps.io/shinygouv-demo-dev/)

# Contribuer au développement du package

Voir les vignettes à l'intention des développeurs du [site de présentation du packages et de ses fonctions](https://spyrales.github.io/shinygouv/articles/index.html)
Voir les vignettes à l'intention des développeurs du [site de présentation du packages et de ses fonctions](https://spyrales.github.io/shinygouv/articles/index.html)

# Code of Conduct

Notez svp qu'un Code de conduite ([Contributor Code of Conduct](https://spyrales.github.io/shinygouv/CODE_OF_CONDUCT.html)) encadre la participation au projet {shinygouv}.
Notez svp qu'un Code de conduite ([Contributor Code of Conduct](https://spyrales.github.io/shinygouv/CODE_OF_CONDUCT.html)) encadre la participation au projet {shinygouv}.

En contribuant à ce projet, vous acceptez de le respecter.
56 changes: 40 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,21 @@

# {shinygouv}

Le package {shinygouv} permet d’utiliser le template existant pour le
`Système de Design de l'Etat` (DSFR) dans vos applications Shiny.
Le package `{shinygouv}` permet d’utiliser le
[`Système de Design de l'Etat`
(DSFR)](https://www.systeme-de-design.gouv.fr/) dans vos applications
Shiny.

Cela leur donnera ce genre de look :

![](man/figures/look_dsfr.png)

Il s’installe depuis github :

``` r
# install.packages("remotes")
remotes::install_github("spyrales/shinygouv")
```

# Comment utiliser le package

Expand All @@ -14,33 +27,44 @@ partie UI:
``` r
library(shiny)
library(shinygouv)

app_ui <- fluidPage_dsfr(
header = header_dsfr(
intitule = "Intitule",
officiel = "Officiel",
nom_site_service = "Nom du site / service",
baseline = "baseline - precisions sur l organisation",
class = "fr-m-1w"
),
intitule = span("D\u00e9mo", br(), "de", br(), "{shinygouv}"),
nom_site_service = "Bienvenue sur l\'application de d\u00e9monstration de {shinygouv}",
baseline = "https://github.com/spyrales/shinygouv"
),
title = "Exemple",
fluidRow_dsfr(
column_dsfr(0,
shiny::p("Exemple colonne"))
column_dsfr(
0,
fileInput("file1", "Ajouter des fichiers", accept = ".csv")
)
)
)
shinyApp(
ui = app_ui,
server = function(input, output) {
}
)
```

# Visualiser un application de démonstration comprenant les composants déjà implémentés:
# Visualiser une application de démonstration comprenant les composants déjà implémentés:

[shinygouv-demo](https://ssm-ecologie.shinyapps.io/shinygouv-demo/)

[shinygouv-demo, version en cours de
developpement](https://ssm-ecologie.shinyapps.io/shinygouv-demo-dev/)

# Contribuer au développement du package

Voir le README du dossier [documentation](dev/documentation)
Voir les vignettes à l’intention des développeurs du [site de
présentation du packages et de ses
fonctions](https://spyrales.github.io/shinygouv/articles/index.html)

# Code of Conduct

Please note that the {shinygouv} project is released with a Contributor
Code of Conduct. By contributing to this project, you agree to abide by
its terms.
Notez svp qu’un Code de conduite ([Contributor Code of
Conduct](https://spyrales.github.io/shinygouv/CODE_OF_CONDUCT.html))
encadre la participation au projet {shinygouv}.

En contribuant à ce projet, vous acceptez de le respecter.
Binary file added man/figures/look_dsfr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 05388b1

Please sign in to comment.