Skip to content
This repository was archived by the owner on Oct 8, 2018. It is now read-only.

Repository files navigation

Datum Ipsum

Realistic placeholder data for design & development

Placeholder data is a lot like placeholder text. It’s a design tool meant to ensure the final product — in our case, a real-time data visualization — matches our mockups. It’s useful in all the same ways placeholder text is useful:

  1. Placeholder data allows a designer to test her assumptions about the product.
  2. Placeholder data makes decision-making much easier by providing realistic constraints.
  3. Placeholder data sets realistic expectations for clients and stakeholders.

Read the full explanation of placeholder data here.

Getting Started

$ git clone git@github.com:planetary/datumipsum
$ cd datumipsum
$ npm install

Then, run gulp build to build the project.

Developing

Run gulp to continuously watch and re-build the project. Airframe will automatically run a server from the build folder at localhost:3000.

Gulp Tasks

TaskDescription
buildbuilds all the registered static resources from assets into build
build:fontsmoves fonts to the build folder
build:imagescompresses images and moves them to the build folder
build:scriptsbundles all client-side javascript files into the build folder via browserify
build:stylescompiles all scss files into the build folder
build:templatescompiles the jade templates to the build folder
cleandeletes all build artifacts
defaultbuilds the site, serves it locally and redeploys when files are changed
helpDisplay this help text.
lintruns all registered linters and out prints any detected issues
lint:scriptslints all non-vendor js(x) files against .eslintrc
lint:styleslints all non-vendor scss files against scss-lint.yml
serveserves static templates locally
serve:browsersyncproxies the localhost server via BrowserSync to dynamically update assets
watchwaits for changes in project files and attempts to rebuild them
watch:fontswatches the source fonts for changes and moves them to the build folder when they do
watch:imageswatches the source images folders and recompresses them when changed
watch:scriptswaits for client-side javascript files to change, then rebuilds them
watch:styleswaits for scss files to change, then rebuilds them
watch:templateswatches the templates folder for changes and recompiles them

Run gulp help at any time to see this list of tasks.

Installing Sublime Text Helpers

SCSS Linting

  1. Open Sublime Text 3, type Cmd+Shift+P to open the prompt and type to select "Package Control: Install Package"
  2. Type to select "SublimeLinter", wait until that finishes installing.
  3. Open the "Install Package" prompt from step 1 again and type to select "SublimeLinter-contrib-scss-lint", wait until that finishes installing.
  4. From the command line, run sudo gem install scss-lint
  5. Restart Sublime Text 3 and you should now see linting issues in the gutter of the editor.

About

Placeholder data helps designers and developers create more robust data-based applications.

Resources

Contributing

Stars

15 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages