hummingbird-client's Introduction

Hummingbird Client

This README outlines the details of collaborating on this application.

Running Tests

npm test

Check out ember-exam for testing options.

Styleguide

JavaScript - Amendments
Ember - Amendments

Styleguide Amendments

JavaScript

Assignment

Use const for all of your references; If you must reassign references, use let instead of var.

Why? This ensures that you can't reassign your references, which can lead to bugs and difficult to comprehend code.

Why? let is block-scoped rather than function-scoped like var.

Ember

Import what you use, do not use globals

For Ember Data, we should import ember-data modules. For Ember, we should import via ember-cli-shims.

import Model from 'ember-data/model';
import attr from 'ember-data/attr';
import computed from 'ember-computed';

export default Model.extend({
  firstName: attr('string'),
  lastName: attr('string'),

  fullName: computed('firstName', 'lastName', {
    get() {
      // Code
    }
  }).readOnly()
});

Use Pods structure

Our directory structure is different to the defined structure in the DockYard styleguide.

This will change again when this Ember RFC is completed.

app/
  components/
    shared-component/
      component.js
      template.hbs
  models/
    user/
      model.js
      adapter.js
      serializer.js
  services/
    current-session.js
  routes/
    dashboard/
      components/
        route-specific-component
          component.js
          template.hbs
      controller.js
      route.js
      template.hbs

Recommend Projects