History

sixteenmillimeter 4c0aa4220c Log with "simple" format, no more json in the console.		2020-01-09 18:05:10 -05:00
..
assets/icons	New icons	2018-03-14 23:15:01 -04:00
css	Visual tweaks for linux	2019-06-26 18:03:54 -04:00
data	Devices discovery WIP	2020-01-05 12:40:38 -05:00
fonts	Fixed font-awesome	2016-04-13 17:36:12 -04:00
js	Add path to main GUI process	2019-07-07 00:00:45 -04:00
less	Visual tweaks for linux	2019-06-26 18:03:54 -04:00
lib	Log with "simple" format, no more json in the console.	2020-01-09 18:05:10 -05:00
scripts	Add devices module after refactor	2019-06-24 14:31:26 -04:00
src	Devices discovery WIP	2020-01-05 12:40:38 -05:00
test	All workshop work. Freeze dev on mac and test on linux	2019-07-29 12:45:13 -04:00
test_old	Re-writing mscript tests.	2019-05-28 17:40:59 -04:00
.gitignore	Hardcode cfg.json with all the new command characters.	2018-01-09 23:02:47 -05:00
Readme.md	Add readme.md work for 1.0.3 release	2018-03-16 10:50:55 -04:00
display.html	Handle different aspect ratio images and screens. Add additional counts on fields and thicken lines. Resolves #19	2019-08-25 15:54:50 -04:00
gulpfile.js	Update all modules, and update gulpfile to gulp4 syntax.	2019-06-14 13:11:28 -04:00
index.html	Incorrectly bound counter to wrong device.	2019-07-24 22:00:53 -04:00
main.js	Downgrade winston from 3 to 2 because it prints better in the console. Change all require statements to imports, requiring only what's used.	2019-08-04 19:38:45 -04:00
package-lock.json	Devices discovery WIP	2020-01-05 12:40:38 -05:00
package.json	Devices discovery WIP	2020-01-05 12:40:38 -05:00

Readme.md

mcopy desktop app

Installation

Installation

The mcopy desktop app can be either installed from a binary (on macOS) or built from source on any platform that supports node.js and Electron apps.

Dependencies

git
node.js

Once node is installed (see below for platform-specific instructions) open your terminal application and enter the following commands:

git clone https://github.com/sixteenmillimeter/mcopy.git
cd mcopy/app
npm install

That's it. Once the npm install process is complete, the app can be launched with:

npm start

If you are interested in running in dev mode, simply use:

npm run dev

macOS

Installing node.js on macOS

The node.js runtime can be easily installed on macOS if you already have Homebrew. Simply install node.js with the command:

brew install node

If you're not using Homebrew, you can also install it from the node.js website.

Linux

Installing node.js on Linux

See this helpful document from the node.js Foundation about installing node.js from different package managers. This will provide more detailed instructions about distro-specific dependencies for node.js and the different packages available. Use a more current version of node, if available. At the time of this writing, development is taking place on node.js version 9.7.1.

Arduino firmware

It's recommended that on linux distributions, you have the Arduino IDE installed for debugging and to ensure that your system serial permissions are configured to communicate with the Arduino devices.

Binary installation

When installing from the pre-built .deb package, you may have to locate the package after installation using the following command:

dpkg -L mcopy-app

In the output, you should see an item like /usr/lib/mcopy-app/mcopy which is the binary that contains the desktop app. I will improve the Linux build process, but will also accept any PRs which improve it as well.

Windows

Installing node.js on Windows

Install node.js on Windows using one of their many install options.