NOTE: This repository is no longer maintained and has been archived. The project has been moved to a new repository: elections-carousel-component.

Introduction

Welcome to the documentation site for elections-carousel: a JavaScript library for a carousel-style presentation of data from a JSON feed of election results.

The elections-carousel project repository is available on GitHub.

Features

• Automatic bundle hash updates;
• Customizable;
• Modular (UMD support);
• Keyboard support.

Quick Start

$ git clone https://github.com/hfagerlund/elections-carousel.git
$ yarn
$ http-server
# browse to http://127.0.0.1:8080/elections.html

Refer to usage for more details.

Project layout

coverage/          # (Istanbul) code coverage reports
dist/              # production-ready (minified,concatenated,transpiled) files
    css/           # compiled CSS (.css) files
    js/            # compiled JS (.js) files
docs/              # documentation
node_modules/      # **npm** package(s)/files
screenshots/       # screenshots of the **elections-carousel** project
src/               # all project source code
    assets/        # additional project files
        fixtures/  # local version of the sample JSON election results feed
        templates  # (Mustache) template files
    js/            # scripts
        elections/ # elections-carousel scripts (unminified)
        vendors/   # third-party scripts - eg. Google fonts
    sass/          # SASS (.scss) files
test/              # (Tape) test files