Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chakrihacker/reactfoo-2018
https://github.com/chakrihacker/reactfoo-2018
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/chakrihacker/reactfoo-2018
- Owner: chakrihacker
- License: mit
- Created: 2018-03-06T01:19:28.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T09:53:00.000Z (about 6 years ago)
- Last Synced: 2024-10-28T16:17:09.978Z (3 months ago)
- Language: JavaScript
- Size: 25.8 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spectacle Boilerplate
## Contents
- [Reference](#reference)
- [Getting Started](#getting-started)
- [Build & Deployment](#build-deployment)
## Reference
The Spectacle core API is available at [https://github.com/FormidableLabs/spectacle/blob/master/README.md](https://github.com/FormidableLabs/spectacle/blob/master/README.md).
## Getting Started
After downloading the boilerplate, your first order of business is to open a terminal and run
```bash
yarn
```
or
```bash
npm install
```
if you're about that life.
Next, run
```bash
rm -R .git
```
to remove the existing version control.
Then, to start up the local server, run
```bash
npm start
```
Open a browser and hit [http://localhost:3000](http://localhost:3000), and we are ready to roll.
## Build & Deployment
Building the dist version of the project is as easy as running
```bash
npm run build
```
If you want to deploy the slideshow to surge, run
```bash
npm run deploy
```