Mir

Ember app powering the frontend of mirai.audio

Docs

• CODE_OF_CONDUCT
• CONTRIBUTING
• CSS Naming Conventions
• humans.txt
• STYLEGUIDE

Prerequisites

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

• Git
• Node.js LTS/10.x
• Ember CLI
• Google Chrome
• Watchman
• Yarn

macOS / OS X Installation:

brew install watchman
brew install yarn          # add --without-node flag if you use nvm
yarn global add ember-cli

Linux (Ubuntu)

npm install -g yarn
yarn global add ember-cli  # Make sure $(yarn global bin) is in your $PATH

Installation

git clone <repository-url>
cd mir
yarn

Running / Development

• yarn start Visit app at http://localhost:4200, requires Ai backend API server to be running.
• yarn start:mirage visit app at http://localhost:4200, a mock (ember-cli-Mirage) server will be running.
• yarn start:debug run node in debug mode for debugging fastboot.
• To run with service workers, without live reload: ember serve --live-reload=false and add ?dev=true to the URL.

Running Tests

• yarn test with code coverage reporting
• ember test --server

Linting

• yarn lint: show all linting warnings & errors.
• yarn lint:js: show Javascript linting warnings & errors.
• yarn lint:js:fix: autofix Javascript linting errors (where possible).
• yarn lint:scss: show SCSS linting warnings & errors.
• yarn lint:hbs: show template (.hbs) linting warnings & errors.

Building

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

Deploying

Environment variables

The following environment variables are available to override fallback (dev) configuration:

# common
API_URL=https://api.mirai.audio  # REST API address
HOST=http://localhost:4200       # Default host
MIRAGE=true                      # Enable Mirage mock server for development

# social login providers
TWITTER_REQUEST_TOKEN_URL=//localhost:4000/login/twitter # ai kickstarts OAuth

# Coveralls API token (how test coverage is reported)
COVERALLS_REPO_TOKEN=  # needs to be set in Circle CI / Travis

If these are defined in a .env file, they will be sourced and made available in the running application.

LICENSE

GPL 3

A product of 青(せい) 心(しん) 工(こう) 機(き) (seishinkouki) Co., Ltd