Skip to content
Command line module to build custom Sheetsee builds
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Ignore .DS_Store Dec 10, 2013
LICENSE Add back-dated license lol Mar 16, 2017
README.md Update readme Mar 16, 2017
bin.js Fix quotes messup Mar 21, 2017
package.json Increase version Mar 29, 2017

README.md

Standard - JavaScript Style Guide

Sheetsee

A Node.js command line tool for creating a custom build of the sheetsee.js library with just the components you want.

If you want to just use the full version, you can grab it here at github.com/jlord/sheetsee.js.

All bundles comes with mapbox.js and mustache.js (since both are available on NPM). Additionally, you'll need to also include tabletop.js in your HTML head like so:

<script src="https://cdnjs.cloudflare.com/ajax/libs/tabletop.js/1.1.0/tabletop.min.js"></script>

To build your Sheetsee you'll need Node.js and npm (the latter comes with the former) on your computer.

Get Node/NPM

Download Node.js from nodejs.org/download. For most users you can just download the Mac .pkg or Windows .msi. Follow the install instructions, both include NPM. Once they're installed, proceed:

To Use

Install sheetsee globally and then run it within the folder of your soon-to-be sheetsee.js project.

Install globally

npm install -g sheetsee

Run from within a project folder

# go into your project's directory
cd my-cool-project
# build sheetsee
sheetsee [options]

Options

Here are the options for the different modules and an option for saving the file (as sheetsee.js).

  • -m or -maps for maps
  • -t or -tables for tables
  • --save to write out the file*

* otherwise, defaults to standardout on your console which you can | pbcopy

So for instance, sheetsee -m -t --save will build you a Sheetsee.js with the basic data functions that are included by default, the map and table sections and save it as a file named sheetsee.js. Running sheetsee -m -t | pbcopy will save the same output to your clipboard.

You can’t perform that action at this time.