mcopy/app
Matt McWilliams f5392aea9f Resolves #74 2023-02-25 12:33:18 -05:00
..
assets/icons New icons 2018-03-14 23:15:01 -04:00
css Display version in app 2023-02-19 11:36:06 -05:00
data Resolves #74 2023-02-25 12:33:18 -05:00
fonts Fixed font-awesome 2016-04-13 17:36:12 -04:00
js Display version in app 2023-02-19 11:36:06 -05:00
less Display version in app 2023-02-19 11:36:06 -05:00
lib Resolves #74 2023-02-25 12:33:18 -05:00
scripts All capper features in app, can shoot blank frames, can turn on capper independently and can schedule blank frames in the sequencer. Some cleanup may be needed but there are no noticeable regressions in the app. TODO: Finish all arduino scripts. 2022-07-15 18:11:26 -04:00
src Major progress on #20. Promised-based websocket command structure is completed. All functionality needs to be placed into individual classes and any new functions get added to the server. 2023-02-25 11:59:56 -05:00
test Restructure includes and type definition files so that mscript runs 2022-08-07 22:18:58 -04:00
test_old Re-writing mscript tests. 2019-05-28 17:40:59 -04:00
.gitignore Established an app signing process for macs using electron-packager. The process takes an enormous amount of time but has so far been running without throwing an exception and the signature is confirmed by codesign. 2021-04-13 14:17:12 -04:00
Readme.md Add readme.md work for 1.0.3 release 2018-03-16 10:50:55 -04:00
display.html Resolves #74 2023-02-25 12:33:18 -05:00
entitlements.plist Established an app signing process for macs using electron-packager. The process takes an enormous amount of time but has so far been running without throwing an exception and the signature is confirmed by codesign. 2021-04-13 14:17:12 -04:00
gulpfile.js Update all modules, and update gulpfile to gulp4 syntax. 2019-06-14 13:11:28 -04:00
index.html Display version in app 2023-02-19 11:36:06 -05:00
main.js Progress on #20. Can start up a server and serve client.js 2023-02-25 02:08:05 -05:00
package-lock.json Resolves #74 2023-02-25 12:33:18 -05:00
package.json Resolves #74 2023-02-25 12:33:18 -05:00
server.html Major progress on #20. Promised-based websocket command structure is completed. All functionality needs to be placed into individual classes and any new functions get added to the server. 2023-02-25 11:59:56 -05:00
tsconfig.json Getting a new error when compiling delay library. Attempt to stop autogenerating d.ts files. 2023-02-19 00:55:17 -05:00

Readme.md

mcopy desktop app

  1. 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

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.