shiny

mirror of https://github.com/rstudio/shiny.git synced 2026-02-05 12:15:14 -05:00

Files

Joe Cheng 6718d377bb Fix and enhance reactlog

* Reactlog shortcut was broken due to reactlog.js not being included in
  the gruntfile
* Reactlog has always shown every reactive event since the beginning of
  the process (or at least since options(shiny.reactlog=TRUE)). This
  commit makes it so Ctrl+F3 invocation only shows reactives that either
  belong to no session (e.g. observers and reactives declared at the top
  of server.R), or belong to this session.

2015-09-13 02:46:52 -07:00

.gitignore

Add Makefile for building web assets

2013-04-24 12:29:46 -05:00

Gruntfile.js

Fix and enhance reactlog

2015-09-13 02:46:52 -07:00

importdocs.sh

Restore HTML generating functions

2014-05-31 08:06:03 -07:00

package.json

Add 'grunt clean' to delete shiny build artifacts

2015-09-09 12:19:43 -07:00

README.md

Lock grunt-contrib-uglify version

2015-05-05 23:01:24 -05:00

updateIonRangeSlider.R

Update to ionRangeSlider 2.0.6. Closes #777

2015-03-27 15:31:37 -05:00

updateStrftime.R

Add strftime Javascript library

2015-07-02 16:50:43 -05:00

README.md

This directory contains build tools for Shiny.

Grunt

Grunt is a build tool that runs on node.js. In Shiny, it is used for concatenating, minifying, and linting Javascript code.

Installing Grunt

Grunt requires Node.js and npm (the Node.js package manager). Installation of these programs differs across platforms and is generally pretty easy, so I won't include instructions here.

Once node and npm are installed, install grunt:

# Install grunt command line tool globally
sudo npm install -g grunt-cli

# Install grunt plus modules for this project
npm install

# To update modules in the future
npm update

Using Grunt

To run all default grunt tasks (concatenation, minification, and jshint), simply go into the tools directory and run:

grunt

It's also useful to run grunt so that it monitors files for changes and run tasks as necessary. This is done with:

grunt watch

One of the tasks concatenates all the .js files in /srcjs together into /inst/www/shared/shiny.js. Another task minifies shiny.js to generate shiny.min.js. The minified file is supplied to the browser, along with a source map file, shiny.min.js.map, which allows a user to view the original Javascript source when using the debugging console in the browser.

During development of Shiny's Javascript code, it's best to use grunt watch so that the minified file will get updated whenever you make changes the Javascript sources.