RC+S Frontend - Brown University

This README outlines the details of collaborating on this Ember-electron application.

RC+S user-facing app. The main goals of this app is to give RC+S patients a way to monitor the status of their implanted device, start-stop recording, find help information.

Prerequisites

You will need the following things properly installed on your computer.

• Git
• Node.js (with npm)
• Ember CLI
• Google Chrome
• CMake

Installation

Clone this repository

git clone https://github.com/openmind-consortium/App-OCD-PatientFrontend.git

Add FontAwesome Registry and Pro TOKEN to npm config (ask CCV)

npm config set "@fortawesome:registry" https://npm.fontawesome.com/
npm config set "//npm.fontawesome.com/:_authToken" <TOKEN>

Install Application Dependencies

cd App-OCD-PatientFrontend
npm install

Install Additional Electron Dependencies

cd electron-app
npm install

Start the application

ember electron

Development

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

• ember test
• ember test --server

Linting

• npm run lint:hbs
• npm run lint:js
• npm run lint:js -- --fix

Committing

Please, use commitizen for your commit messages. You can find the instructions here for the JavaScript package or here for the Python package

Building

• ember build (development)
• ember build --environment production (production)

Electron

This app is built for Electron and uses the ember-electron add-on. The following documentation is from their website. ember electron Run your project in development mode. This works pretty much like ember serve except it runs in Electron. We install the Ember Inspector and Devtron for you, so just use the Developer Tools as you would in your browser. Please note that we do not restart Electron yet when you change code there.

ember electron:test Test your app in Electron. Supports live reloading using the --server flag.

ember electron:package Creates binaries or your app using electron-forge and electron-packager in the background. Options can be specified in ember-electron/electron-forge-config.js.

ember electron:make Creates installers and distribution bundles. For Windows, that means a Squirrel Installer and a Windows Store Package; for macOS, zip/dmg files and a Mac App Store Package, while Linux users enjoy the creation of deb, rpm, and flatpak files. Again, options can be specified in ember-electron/electron-forge-config.js.

ember electron:assemble Assemble Electron application project (useful for debugging builds). For more information, check out the guide on the build pipeline.

Further Reading / Useful Links

• ember.js
• ember-cli
• Development Browser Extensions
  • ember inspector for chrome
  • ember inspector for firefox