README.md

Spectacle Boilerplate

Contents

• Reference
• Getting Started
• Tutorial
• Build & Deployment

Reference

The Spectacle core API is available in the Spectacle Docs.

Getting Started

1. Install dependencies

   $ yarn install

2. Start the webpack server. The server will run at the default webpack-dev-server address, localhost:8080.

   $ yarn start
   
   # Or with a specific port!
   $ yarn start --port=3000

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

From there you can deploy the built slides in dist to services like Netlify, Surge, etc!