The Spectacle core API is available in the Spectacle Docs.
-
Download the boilerplate
git clone [email protected]:FormidableLabs/spectacle-boilerplate.git
-
Remove existing version control
rm -R .git
-
Install dependencies
yarn install
-
Start the webpack server. The server will run at
localhost:3000
.yarn start
If want you a step-by-step guide for getting started with Spectacle, a basic tutorial is available here.
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