Spectacle Boilerplate

Contents

• Reference
• Getting Started
• Tutorial
• Build & Deployment

Reference

The Spectacle core API is available in the Spectacle Docs.

Getting Started

1. Download the boilerplate

   git clone [email protected]:FormidableLabs/spectacle-boilerplate.git

2. Remove existing version control

   rm -R .git

3. Install dependencies

   yarn install

4. Start the webpack server. The server will run at localhost:3000.

   yarn start

Tutorial

If want you a step-by-step guide for getting started with Spectacle, a basic tutorial is available here.

Build & Deployment

Building the dist version of the project is as easy as running

yarn build

If you want to deploy the slideshow to surge, run

yarn deploy

Maintenance Status

Active: Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.