Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pjehan/revealexpress
ExpressJS server to show your RevealJS presentation
https://github.com/pjehan/revealexpress
Last synced: 19 days ago
JSON representation
ExpressJS server to show your RevealJS presentation
- Host: GitHub
- URL: https://github.com/pjehan/revealexpress
- Owner: pjehan
- License: mit
- Created: 2018-06-20T13:20:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-29T14:39:14.000Z (over 1 year ago)
- Last Synced: 2024-12-19T21:23:07.001Z (20 days ago)
- Language: JavaScript
- Size: 1.91 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RevealExpress
> ExpressJS server to show your RevealJS presentation and add interaction with your audience
## What is RevealExpress
Start revealexpress inside your presentation folder, share the URL with your audience and start your interactive presentation.
## Instructions
#### 1 - Install RevealExpress globally
You must have [NodeJS](https://nodejs.org/en/) and [NPM](https://www.npmjs.org) already installed.
In your console, run:
(You may need to add `sudo` at start)
```shell script
npm install -g revealexpress
```
#### 2 - Launch RevealExpress inside your presentation folder
In your console, navigate to your project folder.
Then launch RevealExpress:
```shell script
cd ./my-awesome-presentation
revealexpress
```
RevealExpress should open in your default browser and build a presentation based on your HTML files.
#### 3 - Share the URL with your audience
Simply share the URL that should appear and your audience will have access to your presentation through RevealExpress.
By default, you must be on the same network.
## Features
- Work in any modern browser
- Open in default browser
- Accessible by anyone on the same network
- Audience can follow your presentation in real time
### Additional features
#### PrismJS
You can include [PrismJS](https://prismjs.com) in your slideshow using Webpack and [babel-plugin-prismjs](https://www.npmjs.com/package/babel-plugin-prismjs).
## Configuration
### Command arguments
You can pass arguments to the ```revealexpress``` command to customize the slideshow:
```shell script
revealexpress -n="My slideshow" -p=5000 --revealjs.slideNumber=0
```
You can use the ```--help``` flag to list every available arguments:
```shell script
revealexpress --help
```
You can also use a JavaScript file to send arguments to RevealExpress:
```js
module.exports = {
name: 'My slideshow',
port: 5000,
portws: 5001,
revealjs: {
slideNumber: 0
},
stylesheets: ['assets/css/style.css'],
javascripts: ['assets/js/script.js']
};
```
### RevealJS API
RevealJS expose an [API](https://github.com/hakimel/reveal.js/#api) to let you listen or trigger events and configure the slideshow.
The ```Reveal``` object is accessible once the slideshow has been loaded. You can listen to the 'loaded' event and then use the ```Reveal``` object within the listener callback function:
```js
document.getElementById('revealexpress').addEventListener('loaded', function(event) {
event.Reveal.next();
});
```
> :warning: You should always **wait for the slideshow to be loaded** before interacting with it!
## Credits
##### Development
- Pierre Jehan ([GitHub](https://github.com/pjehan), [Site](https://www.pierre-jehan.com))
This project was inspired by the [Keppler](https://github.com/brunosimon/keppler) project.