https://github.com/dan-harris/presentation-starter
starter boilerplate for presentations framework (spectacle)
https://github.com/dan-harris/presentation-starter
boilerplate presentation-framework react spectacle
Last synced: 3 months ago
JSON representation
starter boilerplate for presentations framework (spectacle)
- Host: GitHub
- URL: https://github.com/dan-harris/presentation-starter
- Owner: dan-harris
- License: mit
- Created: 2018-12-30T03:57:48.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2019-03-18T10:47:41.000Z (over 6 years ago)
- Last Synced: 2025-04-28T16:55:59.027Z (5 months ago)
- Topics: boilerplate, presentation-framework, react, spectacle
- Language: JavaScript
- Size: 1.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spectacle Boilerplate
## Contents
- [Reference](#reference)
- [Getting Started](#getting-started)
- [Tutorial](#tutorial)
- [Build & Deployment](#build-deployment)
## Reference
The Spectacle core API is available in the [Spectacle Docs](https://github.com/FormidableLabs/spectacle/blob/master/README.md).
## Getting Started
1. Download the boilerplate
```sh
git clone git@github.com:FormidableLabs/spectacle-boilerplate.git
```
2. Remove existing version control
```sh
rm -R .git
```
3. Install dependencies
```sh
yarn install
```
4. Start the webpack server. The server will run at [`localhost:3000`](http://localhost:3000).
```sh
yarn start
```
## Tutorial
If want you a step-by-step guide for getting started with Spectacle, a basic tutorial is available [here](https://github.com/FormidableLabs/spectacle/blob/master/docs/tutorial.md).
## Build & Deployment
Building the dist version of the project is as easy as running
```sh
yarn build
```
If you want to deploy the slideshow to surge, run
```sh
yarn deploy
```