https://github.com/jacksingleton/hacker-slides
A simple app that combines Ace Editor and RevealJS. You can write markdown on the left, and preview your presentation on the right.
https://github.com/jacksingleton/hacker-slides
Last synced: over 1 year ago
JSON representation
A simple app that combines Ace Editor and RevealJS. You can write markdown on the left, and preview your presentation on the right.
- Host: GitHub
- URL: https://github.com/jacksingleton/hacker-slides
- Owner: jacksingleton
- License: mit
- Created: 2015-02-10T01:55:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-31T10:55:52.000Z (over 6 years ago)
- Last Synced: 2025-03-23T04:01:52.980Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 26.8 MB
- Stars: 663
- Watchers: 21
- Forks: 51
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sandstorm Hacker Slides
A simple app that combines [Ace Editor](https://github.com/ajaxorg/ace/) and [RevealJS](https://github.com/hakimel/reveal.js)
You can write markdown on the left, and preview your presentation on the right.
[](https://demo.sandstorm.io/appdemo/7qvcjh7gk0rzdx1s3c8gufd288sesf6vvdt297756xcv4q8xxvhh)
## Hack on Hacker Slides
I built this app very quickly and it is unfortunately not one of my main
priorities right now. Contributions are very welcome!
Hacker Slides uses [vagrant-spk](https://github.com/sandstorm-io/vagrant-spk), so dev setup is quite easy.
1. You will need vagrant-spk installed. If you get an error running the
following command, follow the [vagrant-spk installation
instructions](https://docs.sandstorm.io/en/latest/vagrant-spk/installation/)
```bash
$ vagrant-spk -h
usage: /home/jack/bin/vagrant-spk [-h] [--work-directory WORK_DIRECTORY]
...
```
2. Make sure you have [virtualbox](https://www.virtualbox.org/wiki/Downloads) installed before bringing up vagrant vm
```bash
$ VirtualBox -h
Oracle VM VirtualBox Manager 5.0.0
...
```
3. Bring up the Vagrant VM
```bash
$ vagrant-spk up
```
4. Start the application in dev mode
```bash
$ vagrant-spk dev
```
5. Navigate to the Sandstorm dev instance
`http://local.sandstorm.io:6080/`
Here are some things to know about the code base.
* It's a little hacky (it is _Hacker_ Slides after all :))
* [RevealJS 3.0.0](https://github.com/hakimel/reveal.js/tree/3.0.0) has been
copied into the `static/revealjs` directory.
* `main.py` is a super simple python server that mainly just accepts GETs and
PUTs for `/slides.md` and reads and saves markdown from/to `/var/slides.md`
* `index.{html,js}` is the one and only main page for the app. Its only job is to
load Ace Editor on the left side of the screen, and `slides.html` in an
iframe on the right side.
* `slides.{html,js}` sets up RevealJS to load markdown from `/slides.md`. It
also knows how to reload the markdown via a postMessage call.
* `save.js` adds a debounced `keyup` handler to the editor that a) fires off an
ajax PUT to save the markdown content and b) sends a postMessage message to
the RevealJS iframe telling it to reload its markdown preview (which
currently roundtrips to the server again)