/flok-gui

Cross-platform GUI application for using Flok for collaborative live coding

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

flok-gui

A cross-platform GUI application for using Flok for collaborative live coding.

See flok for more.

Update: this project is currently on hold

Development

This repository is based on the electron-webpack template, that comes packed with...

  • Use of webpack-dev-server for development
  • HMR for both renderer and main processes
  • Use of babel-preset-env that is automatically configured based on your electron version
  • Use of electron-builder to package and build a distributable electron application

Make sure to check out electron-webpack's documentation for more details.

Development Scripts

# run application in development mode
yarn dev

# compile source code and create webpack output
yarn compile

# `yarn compile` & create build with electron-builder
yarn dist

# `yarn compile` & create unpacked build with electron-builder
yarn dist:dir

Contributing

Bug reports and pull requests are welcome on GitHub at the issues page. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

This project is licensed under GPL 3+.