Ember.js

Ember.js is a JavaScript framework that does all of the heavy lifting that you'd normally have to do by hand. There are tasks that are common to every web app; Ember.js does those things for you, so you can focus on building killer features and UI.

• Website
• Guides
• API
• Community
• Blog
• Builds

Building Ember.js

1. Ensure that Node.js is installed.
2. Run npm install to ensure the required dependencies are installed.
3. Run npm run-script build to build Ember.js. The builds will be placed in the dist/ directory.

Contribution

See CONTRIBUTING.md

How to Run Unit Tests

1. Follow the setup steps listed above under Building Ember.js.

2. To start the development server, run npm start.

3. Then visit: http://localhost:4200/tests/index.html?package=PACKAGE_NAME. Replace PACKAGE_NAME with the name of the package you want to run. For example:

• Ember.js Runtime
• Ember.js Views
• Ember.js Handlebars

To run multiple packages, you can separate them with commas. You can run all the tests by not specifying a package param:

http://localhost:4200/tests/index.html

You can also pass jquery=VERSION in the test URL to test different versions of jQuery.

From the CLI

1. Install phantomjs from http://phantomjs.org

2. Run npm test to run a basic test suite or run TEST_SUITE=all npm test to run a more comprehensive suite.

Building API Docs

The Ember.js API Docs provide a detailed collection of methods, classes, and viewable source code.

NOTE: Requires node.js to generate.

See http://emberjs.com/ for annotated introductory documentation.

Setup Additional Repos

To preview or build the API documentation, you will need to setup the website and data repos in addition to this repo.

• Clone https://github.com/emberjs/website.git at the same level as the main Ember repo.

• Clone https://github.com/emberjs/data.git at the same level as the main Ember repo. Make sure to follow the setup steps in the Ember Data repo, which includes installing npm modules.

Preview API documentation

• From the website repo, run bundle exec rake preview

• The docs will be available at http://localhost:4567/api

Build API documentation

• From the website repo, run bundle exec rake build

• The website, along with documentation will be built into the build directory