Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dan-harris/presentation-micro-page

Micro-page architecture presso - what, why & how
https://github.com/dan-harris/presentation-micro-page

Last synced: about 2 months ago
JSON representation

Micro-page architecture presso - what, why & how

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 [email protected]: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
```