README.md

In shambhu112/shinyspring: Build Fast Shiny Applications

shinyspring

Build fast, production ready, good looking shiny apps.

Overview

shinyspring provides a development framework, templates and automation to build bs4dash based shinyapps. In collaboration with the sweetmods package shinyframework enables you to focus on developing the core insights based shiny modules while leaving all the other needed stuff for building complete dashboard to the shinyframework.

A lot of peripheral modules related to user authentication , datasource management, job scheduling via targets, Data explorations and several others can be added in a plug and play manner to build complete robust Shiny Apps.

As of now, shinyframework supports bs4dash based Admin LTE3 Templates.The plan is to support several other templates in the future. But, if you are in hurry you can easily modify the template with whisker/mustache and create your own template. You can also adjust current templates to suit to your linking.

Please visit the FAQ section to get a deeper conceptual understanding of the framework.

Install :

devtools::install_github("shambhu112/shinyspring")

New Project Creation : CLI based

• Step1 : Create a new RStdio project and on R Console enter shinyspring::create_new_project() creates a new default project . This creates two file config.yml and user_script.R

• Step 2 : open user_script.R and follow instructions . The following is a snippet from user_script

  ``` r

  Start your Shiny Spring Journey here

  Step 1 : Make sure that your properties in config.yml are set as per your needs

  file.edit('config.yml')

  Step 2 : Create app.R for your application

  params <- config::get(file = "config.yml") # load params shinyspring::create_shinyapp(params = params ) shinyspring::test_config_file(params)

  Step 3 : Launch the App

  shiny::runApp() ```

• Step 3 : After testing the basic app launch you can now create your custom module for you application with shinyspring::create_module("my_custom_module") . Implement the module

• Step 4 : Adjust config.yml to add menu’s and leverage pre-built / tested sweetmods that can be used in your app in a plug and play manner . The power of shinyspring is in the reuse of sweetmods.

  For Detailed Step by Step guide. Please refer to Starter App Examples

Rstudio cloud Project

Thislink on Rstudio cloud recreates the above steps

New Project Creation in Rstudio

Note: This approach is still Work in progress. some options fail.

| Screen 1 | Screen 2 | |--------------------------------------------------------------|--------------------------------------------------------------| | | |

FAQ’s

• Why Shinyspring ? What is the value add ? Answer

• What is the development framework for Shinyspring ? Answer

• Explain the Core UI concepts. Answer

• What are current modules available and what are the plans for future ?

• How can I build modules that work with shiynspring ?

• How can I contribute to shinyspring ?

• Is Shinyspring robust and production ready ?

shambhu112/shinyspring documentation built on July 9, 2021, 2:07 p.m.