Merge pull request #24 from ThinkR-open/1-bring-the-package-up-to-sta…

…ndard

Bring the package up to standard

.Rbuildignore

@@ -12,3 +12,4 @@ $run_dev.*
 ^codecov\.yml$
 ^manifest\.json$
 ^index\.html$
+^CODE_OF_CONDUCT\.md$

CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at codeofconduct@thinkr.fr. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

DESCRIPTION

@@ -2,7 +2,8 @@ Package: signature
 Title: Fill your email signature
 Version: 0.0.0.9000
 Authors@R: c(
-    person("Arthur", "Bréant", , "arthur@thinkr.fr", role = c("cre", "aut")),
+    person("Arthur", "Bréant", , "arthur@thinkr.fr", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0003-1668-0963")),
     person("ThinkR", role = "cph")
   )
 Description: Fill your email signature from Thinkr tempalte.

NEWS.md

@@ -0,0 +1,5 @@
+# signature 0.0.0.9000
+
+* Create a new app to easily manage our email signature
+* Add inputs to update the signature
+* Add a banner and a redirection url

R/mod_preview.R

@@ -28,8 +28,8 @@ mod_preview_ui <- function(id) {
             id = "body",
             p("Hello la team !"),
             p("Vous pouvez \u00e9diter votre signature depuis cette interface."),
-            p("Il vous restera ensuite \u00e0 suivre les consignes pour l\'ins\u00e9rer en signature."),
-            p("Merci :)")
+            p("Il vous restera ensuite \u00e0 l\'ins\u00e9rer en signature."),
+            HTML("Merci &#128513"),
           ),
           tags$div(
             id = "copy",

README.Rmd

@@ -13,11 +13,81 @@ knitr::opts_chunk$set(
 )
 ```
 
-# signature
+# signature <img src="man/figures/logo.png" align="right" height="137" />
 
 <!-- badges: start -->
 [![R-CMD-check](https://github.com/ThinkR-open/signature/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/signature/actions/workflows/R-CMD-check.yaml)
 [![Codecov test coverage](https://codecov.io/gh/ThinkR-open/signature/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ThinkR-open/signature?branch=main)
 <!-- badges: end -->
 
-The goal of {signature} is to filled your email signature.
+
+## Demo
+
+Try the app at **https://connect.thinkr.fr/signature/**
+
+## Try locally
+
+```{r, eval=FALSE}
+remotes::install_github("ThinkR-open/signature")
+```
+
+then: 
+
+```{r, eval=FALSE}
+signature::run_app()
+```
+
+## Description
+
+This application offers a **graphical interface** to **simplify the creation and/or maintenance of your email signature**. 
+
+No more struggling with images or getting lost in the HTML code, the application offers a series of inputs to update the signature. 
+
+Enter your name, first name, email and other information to fill in your signature.
+
+This application also proposes to **copy the HTML code** via a button in order to **paste it in the parameters of your mailbox**.
+
+Finally, the banner (image at the bottom of the signature) and the redirection by clicking on it are easy to update. No more asking everyone to update their signature to update the banner and the redirection.
+
+
+Now you just have to :  
+- modify the image stored in this repo to update the banner  
+- modify the link of the html file at the root of the project
+
+## How to update the signature?
+
+### The banner
+
+To update the banner image, replace the `current_banner.png` with a new image with the same name.
+
+```{r, echo=FALSE}
+fs::dir_tree(path = "inst/app/www/templates/thinkr/assets")
+```
+
+### The redirection url
+
+To update the redirection url, modify the `script` inside `index.html` at the root of the package:
+
+```{html}
+<script>
+  window.location.replace("https://thinkr.fr/blog/");
+</script>
+```
+
+### The look of the signature
+
+To change the look of the signature more generally, you need to modify the HTML inside `template.html`
+
+```{r, echo=FALSE}
+fs::dir_tree(path = "inst/app/www/templates/thinkr")
+```
+
+## Mockup
+
+This application was built and firstly designed on Figma:  
+https://www.figma.com/file/u95KvEqgWLB8arxt7saZcJ/Untitled?node-id=0%3A1&t=CN1gLBLC5YN1SEOg-1
+
+
+## Code of Conduct
+
+Please note that the signature project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

README.md

@@ -1,13 +1,96 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# signature
+# signature <img src="man/figures/logo.png" align="right" height="137" />
 
 <!-- badges: start -->
 
-[![R-CMD-check](https://github.com/ThinkR-open/signature/workflows/R-CMD-check/badge.svg)](https://github.com/ThinkR-open/signature/actions)
+[![R-CMD-check](https://github.com/ThinkR-open/signature/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ThinkR-open/signature/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/ThinkR-open/signature/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ThinkR-open/signature?branch=main)
 <!-- badges: end -->
 
-The goal of {signature} is to filled your email signature.
+## Demo
+
+Try the app at **<https://connect.thinkr.fr/signature/>**
+
+## Try locally
+
+``` r
+remotes::install_github("ThinkR-open/signature")
+```
+
+then:
+
+``` r
+signature::run_app()
+```
+
+## Description
+
+This application offers a **graphical interface** to **simplify the
+creation and/or maintenance of your email signature**.
+
+No more struggling with images or getting lost in the HTML code, the
+application offers a series of inputs to update the signature.
+
+Enter your name, first name, email and other information to fill in your
+signature.
+
+This application also proposes to **copy the HTML code** via a button in
+order to **paste it in the parameters of your mailbox**.
+
+Finally, the banner (image at the bottom of the signature) and the
+redirection by clicking on it are easy to update. No more asking
+everyone to update their signature to update the banner and the
+redirection.
+
+Now you just have to :  
+- modify the image stored in this repo to update the banner  
+- modify the link of the html file at the root of the project
+
+## How to update the signature?
+
+### The banner
+
+To update the banner image, replace the `current_banner.png` with a new
+image with the same name.
+
+    #> inst/app/www/templates/thinkr/assets
+    #> ├── current_banner.png
+    #> └── logo.jpg
+
+### The redirection url
+
+To update the redirection url, modify the `script` inside `index.html`
+at the root of the package:
+
+``` html
+<script>
+  window.location.replace("https://thinkr.fr/blog/");
+</script>
+```
+
+### The look of the signature
+
+To change the look of the signature more generally, you need to modify
+the HTML inside `template.html`
+
+    #> inst/app/www/templates/thinkr
+    #> ├── assets
+    #> │   ├── current_banner.png
+    #> │   └── logo.jpg
+    #> ├── icon.html
+    #> └── template.html
+
+## Mockup
+
+This application was built and firstly designed on Figma:  
+<https://www.figma.com/file/u95KvEqgWLB8arxt7saZcJ/Untitled?node-id=0%3A1&t=CN1gLBLC5YN1SEOg-1>
+
+## Code of Conduct
+
+Please note that the signature project is released with a [Contributor
+Code of
+Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
+By contributing to this project, you agree to abide by its terms.