5c13ac4658
Adds a badge showing the number of people helping this repo on CodeTriage. [](https://www.codetriage.com/msoedov/hacker-slides) ## What is CodeTriage? CodeTriage is an Open Source app that is designed to make contributing to Open Source projects easier. It works by sending subscribers a few open issues in their inbox. If subscribers get busy, there is an algorithm that backs off issue load so they do not get overwhelmed [Read more about the CodeTriage project](https://www.codetriage.com/what). ## Why am I getting this PR? Your project was picked by the human, @schneems. They selected it from the projects submitted to https://www.codetriage.com and hand edited the PR. How did your project get added to [CodeTriage](https://www.codetriage.com/what)? Roughly 10 months ago, [msoedov](https://github.com/msoedov) added this project to CodeTriage in order to start contributing. ## What does adding a badge accomplish? Adding a badge invites people to help contribute to your project. It also lets developers know that others are invested in the longterm success and maintainability of the project. You can see an example of a CodeTriage badge on these popular OSS READMEs: - [](https://www.codetriage.com/rails/rails) https://github.com/rails/rails - [](https://www.codetriage.com/crystal-lang/crystal) https://github.com/crystal-lang/crystal ## Have a question or comment? While I am a bot, this PR was manually reviewed and monitored by a human - @schneems. My job is writing commit messages and handling PR logistics. If you have any questions, you can reply back to this PR and they will be answered by @schneems. If you do not want a badge right now, no worries, close the PR, you will not hear from me again. Thanks for making your project Open Source! Any feedback is greatly appreciated.
2.5 KiB
2.5 KiB
Hacker Slides
This repo is a reworked version of Sandstorm Hacker Slides which features easy set up run outside of Sandstorm and without vagrant-spk. Likewise you can publish and edit your previous markdown slides which is not supported in the original version.
Features:
- Reach ui editor
- Markdown markup
- Live reload
- Color schemes
- Pdf print
- Demo version
- Tiny 10 Mb docker image
- Optional Basic auth
| Edit mode | Published | |
|---|---|---|
 |
 |
|
 |
 |
Run from docker image
docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
Build locally
To build and run it locally
go get
go run main.go
[GIN-debug] Listening and serving HTTP on :8080
And then you can just open http://127.0.0.1:8080 and it's ready to use with sample slides.
Run with docker
docker run -it -p 8080:8080 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
Protect slides with password
Basic auth (disabled by default)
USER=bob PASSWORD=password1 go run main.go
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
- using env: export GIN_MODE=release
- using code: gin.SetMode(gin.ReleaseMode)
WARN[0000] Auth mode enabled
WARN[0000] Visit http://bob:password1@0.0.0.0:8080
docker run -it -p 8080:8080 -e USER=bob -e PASSWORD=password1 -v $(pwd)/slides:/app/slides msoedov/hacker-slides
Getting Help
For feature requests and bug reports submit an issue to the GitHub issue tracker