Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 1.92 KB

building.md

File metadata and controls

39 lines (25 loc) · 1.92 KB
Raw

Right-sizing

You can customize your Sheetsee build with just the parts you want to use, for example to only include the mapping module or only the tables module. If you want to just use the full version, you can grab it here at github.com/jlord/sheetsee.js.

All builds come with Mustache.js and Leaflet.js. Additionally, you'll need to link to Tabletop.js your HTML head like so:

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

To build a custom Sheetsee you'll need Node.js on your computer familiarity with the command line.

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. Then install sheetsee.

Install sheetsee from npm

The sheetsee (with no '.js') module is the tool for building custom Sheetsee builds. Install sheetsee globally and then run it within the folder of your soon-to-be Sheetsee project.

Install globally

npm install -g sheetsee

Run from within a project folder

sheetsee [options]

Here are the options for the different modules. If you want save the generated file as sheetsee.js then add the --save option.

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

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

So for instance, sheetsee -m --save will build you a Sheetsee with the basic data functions and the map section, leaving out the tables section. It will save it as a file named 'sheetsee.js'. Running sheetsee -m | pbcopy will save the output to your clipboard.