diff --git a/package.json b/package.json index 5358a65..8d58e30 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ }, "main": "bin/index.js", "scripts": { - "demo-folder": "cd test/demo-folder && node ../../bin 'Demo folder' --open false --test true --initial-send true", + "demo-folder": "cd test/demo-folder && node ../../bin 'Demo folder' --open false --initial-send true", "site-dev": "node site/build/dev-server.js", "site-build": "node site/build/build.js", "dev": "npm-run-all --parallel demo-folder site-dev" diff --git a/readme.md b/readme.md index b3841c2..73f0bd6 100644 --- a/readme.md +++ b/readme.md @@ -1,41 +1,49 @@ # Keppler -An efficient way to share your code while presenting +Real time code sharing for you 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 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. +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. -Keppler is easy to install and works with NodeJS. - -Keppler screen +Keppler screen +Keppler screen +Keppler screen ## Instructions -#### Requirements +#### 1 - Install Keppler globally -* [NodeJS](https://nodejs.org/en/) installed -* Keppler installed globally -* Viewers connected to the same network - -#### Install Keppler 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) ``` npm install -g keppler ``` -#### Start Keppler inside the project folder + +#### 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" ``` -Share the URL that should appear with the viewers. +Keppler should open in your default browser and start watching any changes you make on the folder. -#### config +#### 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 argument when calling Keppler. @@ -53,40 +61,43 @@ Arguments list |name|shortcut|default value|description| |---|---|---|---| -|`--debug`|`-d`|*(number)*`1`|Debug level (`0`: almost no log, `1`: some logs, `2`: many logs)| -|`--name`|`-n`|*(string)*`No name`|Project name (you can simply add a string after `keppler` keyword like `keppler "My project"`)| +|`--debug`|`-d`|*(number)*`1`|Debug level
`0`: almost no log
`1`: primary logs
`2`: too much logs| +|`--name`|`-n`|*(string)*`No name`|Project name
(you can simply add a string after `keppler` keyword like `keppler "My project"`)| |`--port`|`-p`|*(number)*`1571`|Server port| |`--exclude`|`-e`|*(string)*`**/.DS_Store,node_modules/**,vendor/**,.git`|Files to exclude| |`--open`|`-o`|*(bool)*`true`|Open in default browser| -|`--test`|`-t`|*(bool)*`false`|Start a test project| -|`--initial-send`|`-i`|*(bool)*`false`|Send files in folder at start| +|`--test`|`-t`|*(bool)*`false`|Start a test project with testing contents| +|`--initial-send`|`-i`|*(bool)*`false`|Send current files in the folder at start| |`--max-file-size`|`-m`|*(number)*`99999`|Maximum file size in octets| ## Features - Work in any modern browser -- Files tree +- File tree +- Fuzzy search - File history/versions - File versions differences -- Easy copy +- Easy copy to clipboard - Accessible by anyone on the same network - App like design - Syntax coloring - Multiple projects in one Keppler instance - -## Futur features - -- Chat with possibility to associate messages with lines and files -- Log project URL and open in default browser +- Chat with other viewers and associate specific files and lines with your messages +- Open in default browser - Download file button - Download project button -- Keyboard navigation -- In app notifications -- Browser notifications -- Toggle folder -- Retractable sidebar -- File searching/filtering +- Alert button - Tooltips -- Tablet compatible -- Vue.js -- Font-size control + +## Credits + +##### Development + +- Bruno Simon ([GitHub](https://github.com/brunosimon), [Twitter](https://twitter.com/bruno_simon/), [Site](https://bruno-simon.com)) + +##### UX / UI + +- Tom Bonnike +- Thibaud Vaubourg +- Aymeric Sans +- Axel Chalon \ No newline at end of file diff --git a/resources/design/home.psd b/resources/design/home.psd deleted file mode 100644 index 919163a..0000000 Binary files a/resources/design/home.psd and /dev/null differ diff --git a/resources/design/project.psd b/resources/design/project.psd deleted file mode 100644 index 111fc75..0000000 Binary files a/resources/design/project.psd and /dev/null differ diff --git a/resources/screenshots/originals.psd b/resources/screenshots/originals.psd new file mode 100644 index 0000000..8810e19 Binary files /dev/null and b/resources/screenshots/originals.psd differ diff --git a/resources/screenshots/screen-project-1.png b/resources/screenshots/screen-project-1.png index ab0598f..830b48b 100644 Binary files a/resources/screenshots/screen-project-1.png and b/resources/screenshots/screen-project-1.png differ diff --git a/resources/screenshots/screen-project-2.png b/resources/screenshots/screen-project-2.png index be2507e..830a986 100644 Binary files a/resources/screenshots/screen-project-2.png and b/resources/screenshots/screen-project-2.png differ diff --git a/resources/screenshots/screen-project-3.png b/resources/screenshots/screen-project-3.png new file mode 100644 index 0000000..56a45e3 Binary files /dev/null and b/resources/screenshots/screen-project-3.png differ diff --git a/resources/svg/apache.svg b/resources/svg-files/apache.svg similarity index 100% rename from resources/svg/apache.svg rename to resources/svg-files/apache.svg diff --git a/resources/svg/audio.svg b/resources/svg-files/audio.svg similarity index 100% rename from resources/svg/audio.svg rename to resources/svg-files/audio.svg diff --git a/resources/svg/c.svg b/resources/svg-files/c.svg similarity index 100% rename from resources/svg/c.svg rename to resources/svg-files/c.svg diff --git a/resources/svg/coffee.svg b/resources/svg-files/coffee.svg similarity index 100% rename from resources/svg/coffee.svg rename to resources/svg-files/coffee.svg diff --git a/resources/svg/css.svg b/resources/svg-files/css.svg similarity index 100% rename from resources/svg/css.svg rename to resources/svg-files/css.svg diff --git a/resources/svg/folder-active.svg b/resources/svg-files/folder-active.svg similarity index 100% rename from resources/svg/folder-active.svg rename to resources/svg-files/folder-active.svg diff --git a/resources/svg/folder.svg b/resources/svg-files/folder.svg similarity index 100% rename from resources/svg/folder.svg rename to resources/svg-files/folder.svg diff --git a/resources/svg/font.svg b/resources/svg-files/font.svg similarity index 100% rename from resources/svg/font.svg rename to resources/svg-files/font.svg diff --git a/resources/svg/git.svg b/resources/svg-files/git.svg similarity index 100% rename from resources/svg/git.svg rename to resources/svg-files/git.svg diff --git a/resources/svg/html.svg b/resources/svg-files/html.svg similarity index 100% rename from resources/svg/html.svg rename to resources/svg-files/html.svg diff --git a/resources/svg/image.svg b/resources/svg-files/image.svg similarity index 100% rename from resources/svg/image.svg rename to resources/svg-files/image.svg diff --git a/resources/svg/jade.svg b/resources/svg-files/jade.svg similarity index 100% rename from resources/svg/jade.svg rename to resources/svg-files/jade.svg diff --git a/resources/svg/js.svg b/resources/svg-files/js.svg similarity index 100% rename from resources/svg/js.svg rename to resources/svg-files/js.svg diff --git a/resources/svg/json.svg b/resources/svg-files/json.svg similarity index 100% rename from resources/svg/json.svg rename to resources/svg-files/json.svg diff --git a/resources/svg/less.svg b/resources/svg-files/less.svg similarity index 100% rename from resources/svg/less.svg rename to resources/svg-files/less.svg diff --git a/resources/svg/md.svg b/resources/svg-files/md.svg similarity index 100% rename from resources/svg/md.svg rename to resources/svg-files/md.svg diff --git a/resources/svg/php.svg b/resources/svg-files/php.svg similarity index 100% rename from resources/svg/php.svg rename to resources/svg-files/php.svg diff --git a/resources/svg/pug.svg b/resources/svg-files/pug.svg similarity index 100% rename from resources/svg/pug.svg rename to resources/svg-files/pug.svg diff --git a/resources/svg/random.svg b/resources/svg-files/random.svg similarity index 100% rename from resources/svg/random.svg rename to resources/svg-files/random.svg diff --git a/resources/svg/sass.svg b/resources/svg-files/sass.svg similarity index 100% rename from resources/svg/sass.svg rename to resources/svg-files/sass.svg diff --git a/resources/svg/sql.svg b/resources/svg-files/sql.svg similarity index 100% rename from resources/svg/sql.svg rename to resources/svg-files/sql.svg diff --git a/resources/svg/stylus.svg b/resources/svg-files/stylus.svg similarity index 100% rename from resources/svg/stylus.svg rename to resources/svg-files/stylus.svg diff --git a/resources/svg/svg.svg b/resources/svg-files/svg.svg similarity index 100% rename from resources/svg/svg.svg rename to resources/svg-files/svg.svg diff --git a/resources/svg/twig.svg b/resources/svg-files/twig.svg similarity index 100% rename from resources/svg/twig.svg rename to resources/svg-files/twig.svg diff --git a/resources/svg/txt.svg b/resources/svg-files/txt.svg similarity index 100% rename from resources/svg/txt.svg rename to resources/svg-files/txt.svg diff --git a/resources/svg/video.svg b/resources/svg-files/video.svg similarity index 100% rename from resources/svg/video.svg rename to resources/svg-files/video.svg diff --git a/resources/svg/xml.svg b/resources/svg-files/xml.svg similarity index 100% rename from resources/svg/xml.svg rename to resources/svg-files/xml.svg diff --git a/resources/svg/yml.svg b/resources/svg-files/yml.svg similarity index 100% rename from resources/svg/yml.svg rename to resources/svg-files/yml.svg diff --git a/resources/svg/zip.svg b/resources/svg-files/zip.svg similarity index 100% rename from resources/svg/zip.svg rename to resources/svg-files/zip.svg diff --git a/test/demo-folder/test-1.html b/test/demo-folder/test-1.html index a8b8eb0..8687d32 100644 --- a/test/demo-folder/test-1.html +++ b/test/demo-folder/test-1.html @@ -2,14 +2,20 @@ - Document + Mon super site
- Bonjour + +

Bonjour

+ + +