Skip to content
This repository has been archived by the owner on Sep 14, 2020. It is now read-only.

Latest commit

 

History

History
56 lines (36 loc) · 1.05 KB

README.md

File metadata and controls

56 lines (36 loc) · 1.05 KB

Spectacle Boilerplate

Contents

Reference

The Spectacle core API is available in the Spectacle Docs.

Getting Started

  1. Download the boilerplate

    git clone git@github.com: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