/jace-dev

Primary LanguageJavaScriptMIT LicenseMIT

JACE = DJ + Vue. Widget & statistical presentation platform based on Vuejs for DJ distributed data processing.

Gitter

Project name GitHub version Build Status Dependencies Coverage Status Issue Stats Issue Stats Stories in Ready

Prerequisites

Required software:

  • node.js (or io.js) is installed (better 0.11.x or newer) Install latest node.js using npm install -g n; n latest as root/admin user
  • npm is installed (minimum 2.0, check with npm --version. Upgrade to newer npm with npm install -g npm and make sure new npm is in PATH with higher priority than the old one.
  • mongodb is installed

Highly recommended:

  • gulp is installed (run npm install -g gulp as admin)

Optional:

  • chrome and firefox (optional) are installed
  • docker and docker-compose. Installation instructions - Ubuntu, Windows,

Build

To run this project from terminal run the following command:

 npm install
 npm start

API docs

Debugging:

Project style guides:

  • MOST IMPORTANT: follow the existing code style
  • Make sensible variable names
  • Don't use git pull, use git pull --rebase or git up (git plugin) instead. You can run git config branch.master.rebase true to make git pull behave like git pull --rebase on project basis.
  • Use commit names in format [SCOPE] explanation where SCOPE is a feature, subproject or component. Examples:
    • [build] Change gulp task
    • [front-end] added new feature
    • [hotfix] fixed mistake in previous commit
    • [test] added new tests
    • [travis] removed module
    • [heroku] changed env variables
  • Use branches:
    • master branch for stable code synced from develop and bugfixes.
    • develop branch for code in development. Should be regularly merged into master
    • feature-branches for single features development. Should be merged into develop.
    • git tags on master branch to mark releases (like v0.4.3 or v1.0)

Used technologies

  • git (version control)
  • ES6/7 JavaScript (modules, async/await, classes, arrow functions etc...)
  • Sails.JS (node.js MVC framework)
  • npm (front-end dev. dependencies)
  • gulp (front-end task-runner)
  • vuejs (MVVM front-end framework)
  • SystemJS (universal dependency loader)
  • LESS (CSS replacement)
  • travis (Continuous Integration)
  • heroku (PaaS)
  • gravatar (service for centralized user avatar (image) store)
  • docker (deployment) (deployment)