diff --git a/README.Rmd b/README.Rmd index 1d544b94..1f94e0da 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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: @@ -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. diff --git a/README.md b/README.md index d7c5b213..682301d3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/man/figures/look_dsfr.png b/man/figures/look_dsfr.png new file mode 100644 index 00000000..25849d33 Binary files /dev/null and b/man/figures/look_dsfr.png differ