pbucci / MacaronBit

Macaron

Vibrotactile Icon Editor

Quick install:

For Windows, rename "package[windows use this].json" to "package.json" For Mac, rename "package[macs use this].json" to "package.json"

Run the following commands: npm install npm run deploy

Run with:

node server.js

Build Environment

Macaron requires the following libraries:

• React
• NodeJS tools
• NodeJS Package Manager (NPM)
• Webpack
• d3
• reflux

Begin by installing NPM for your OS. Once NPM is installed, install react as follows: (note: Code below only work with latest version of Node.js. Try updating node version with "sudo npm install npm -g")

npm install react --save

and install webpack:

• npm install -g webpack
• npm i webpack --save-dev
• npm i webpack-dev-server --save (note: If you get permission errors, try beginning each command with sudo)

and the JSX syntax handler:

• npm install babel-loader --save-dev

You will also need to install the following libraries:

• d3: npm install d3 --save
• reflux: npm install reflux --save
• firebase: npm install firebase --save

And you will need two custom loaders for webpack, to import Audiolet, a non-NPM library contained in thirdparty/audiolet:

• npm install imports-loader --save
• npm install script-loader --save

As well, the following two loaders for loading CSS stylesheets:

• npm install style-loader css-loader --save-dev

You'll need this for websockets:

• npm install socket.io --save
• npm install express --save

And this to talk to the Arduino:

• npm install johnny-five --save

Now, you can build the environment with npm run deploy. Note that there are two packages for windows and mac users: "package[mac use this].json", and "package[windows use this].json". Rename the package corresponding to your OS to "package.json". Also note that .gitignore has been updated to ignore "package.json", so if you are adding packages...beware!

Make sure the Arduino is loaded up with StandardFirmata (Examples > Firmata > Standard Firmata). The Bit should be plugged in as follows:

• Data pin (usually orange or yellow) : 9
• High/positive (usually red) : 5V
• Low/negative/ground (usually black or brown) : any GND

Install xCode command line tools. (Note: To compile node-serialport with Node.js 4.x+, you will need to use g++ v4.8 or higher.)

Add this to fix the serialport warning:

• sudo npm install serialport

You can start serving on localhost:8080 with node server.