Bruno Simon
66 lines
1.5 KiB
Markdown
66 lines
1.5 KiB
Markdown
# Keppler
|
|
|
|
An efficient way to share your code while presenting
|
|
|
|
### What is keppler
|
|
|
|
Keppler lets you share your code during a presentation.
|
|
|
|
Start keppler inside your project folder, share the URL with the viewers and start coding. When you save or change any file, viewers receive them, can browse through the files tree and discover changes you've made.
|
|
|
|
Keppler is easy to install and works with NodeJS.
|
|
|
|
<img width="600" height="374" src="https://github.com/brunosimon/keppler/raw/master/resources/screenshots/screen-project-2.png" alt="Keppler screen">
|
|
|
|
### Instructions
|
|
|
|
**Requirements**
|
|
* [NodeJS](https://nodejs.org/en/) installed
|
|
* Keppler installed globally
|
|
* Viewers connected to the same network
|
|
|
|
**Install Keppler globally**
|
|
|
|
```
|
|
npm install -g keppler
|
|
```
|
|
|
|
**Start Keppler inside the project folder**
|
|
|
|
```
|
|
cd ./my-awesome-project
|
|
keppler "My awesome project"
|
|
```
|
|
|
|
Share the URL that should appear with the viewers.
|
|
|
|
### Current features
|
|
- Files tree
|
|
- File history/versions
|
|
- File versions differences
|
|
- Easy copy
|
|
- Accessible by anyone on the same network
|
|
- App like design
|
|
- Multiple projects in one Keppler instance
|
|
|
|
### Futur features
|
|
|
|
- Log project URL and open in default browser
|
|
- Download file button
|
|
- 404
|
|
- Config file
|
|
- Keyboard navigation
|
|
- In app notifications
|
|
- Browser notifications
|
|
- Toggle folder
|
|
- Retractable sidebar
|
|
- File searching/filtering
|
|
- Project history
|
|
- Tooltips
|
|
- Open multiple files
|
|
- Unit testing
|
|
- Tablet compatible
|
|
- Angular 2 or React
|
|
- Font-size control
|
|
- Theme control
|