keppler/readme.md

Keppler

Real time code sharing for your lectures and presentations.

What is keppler

Keppler lets you share your code during a presentation.

Start keppler inside your project folder, share the URL with your audience and start coding. Any time you save a file, viewers will receive those changes. They can browse through the files, go back in history, copy the code, download the project, preview images, chat with other viewers, ask the presenter to slow down, etc.

Instructions

1 - Install Keppler globally

You must have NodeJS and NPM already installed. In your console, run: ^{(You may need to add sudo at start)}

npm install -g keppler

2 - Launch Keppler inside your project folder

In your console, navigate to your project folder. Then launch Keppler with the name of your choice:

cd ./my-awesome-project
keppler "My awesome project"

Keppler should open in your default browser and start watching any changes you make on the folder.

3 - Share the URL with your audience

You must be on the same network. Simply share the URL that should appear with your audience and they will start receiving your changes.

Configuration

You can add configuration arguments when calling Keppler.

keppler "My project" --debug 0 --port 1234 --exclude "node_modules/**" --open true --test true --initial-send true --max-file-size 99999

Same arguments using shortcuts

keppler "My project" -d 0 -p 1234 -e "node_modules/**" -oti -m 99999

Arguments list

parameter	--debug
shortcut	--d
default value	(number)1
description	Debug level 0: almost no log 1: primary logs 2: too much logs

parameter	--name
shortcut	-n
default value	(string)No name
description	Project name (you can simply add a string after keppler keyword like keppler "My project")

parameter	--port
shortcut	-p
default value	(number)1571
description	Server port

parameter	--exclude
shortcut	-e
default value	(string)**/.DS_Store,node_modules/**,vendor/**,.git
description	List of paths to exclude seperated with commas with wildcards support

parameter	--open
shortcut	-o
default value	(bool)true
description	Open Keppler in default browser

parameter	--test
shortcut	-t
default value	(bool)false
description	Start a test project with demo contents :warning:Should not be used for a real presentation

parameter	--initial-send
shortcut	-i
default value	(bool)false
description	Send current files in the folder at start :warning:To much files may cause issues

parameter	--max-file-size
shortcut	-m
default value	(number)99999
description	Maximum file size in octets (99999 ≈ 100ko)

Features

• Work in any modern browser
• File tree
• Fuzzy search
• File history/versions
• File versions differences
• Easy copy to clipboard
• Accessible by anyone on the same network
• App like design
• Syntax coloring
• Multiple projects in one Keppler instance
• Chat with other viewers and associate specific files and lines with your messages
• Open in default browser
• Download file button
• Download project button
• Alert button
• Tooltips

Credits

Development

• Bruno Simon (GitHub, Twitter, Site)

UX / UI

• Tom Bonnike
• Thibaud Vaubourg
• Aymeric Sans
• Axel Chalon