Watch local files for changes and share them with the world 🌎
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
app
assets
client
flow-typed
internals
resources
test
.babelrc
.editorconfig
.eslintignore
.eslintrc
.flowconfig
.gitattributes
.gitignore
.stylelintrc
.travis.yml
README.md
appveyor.yml
package-lock.json
package.json
webpack.config.base.js
webpack.config.eslint.js
webpack.config.main.prod.js
webpack.config.renderer.dev.dll.js
webpack.config.renderer.dev.js
webpack.config.renderer.prod.js
yarn.lock

README.md

logo

Carbon

Carbon (from Carbon Paper) is a desktop app to share files. What makes Carbon different is that it watches files for changes and updates all connected clients in real time. It was originally designed to use when teaching programming, showing code or when you need to share files with a live audience.

You can use it to share files only in your local network or you can enable world mode to create a public access domain using ngrok.

Carbon is available for macOS, Linux and Windows (untested).

demo

Usage

Download the latest release here. Open the app, drop files into the main window and click the start button. This will enable a server over the local network. Clients on the same network can connect with the supplied URL. If your firewall blocks your server or you have issues inside the network, you can enable world mode by clicking in the globe icon, that will create a new URL that's available to anyone. Use with caution!

Every client that connects to the supplied URL will have the same files dropped in the app and they will update live using sockets.

inter

You can use Carbon with any text editor. Updates will be sent to clients whenever files changes are detected. For character level updates you can use different settings depending on the editor of your choice:

  • VSCode: Enable the Auto Save functionality for millisecond saves with files.autoSave: afterDelay.
  • Atom: Install the auto-save on Change plugin and set the amount of time to auto-save.
  • Sublime: Install the auto-save plugin that saves the current file after every modification.

Client

Every connected user receives a page with a socket connection to the server. This pages allows for save options and theme personalization.

demo

Develop

Carbon was made with electron-react-boilerplate that uses: Electron, React, Redux, React Router, Webpack, and React Transform HMR.

The client page is built with create-react-app

To develop the electron app:

sudo yarn start

To package the app:

sudo yarn package

To build the client side:

cd client
yarn start

Licence

TBD