Skip to content

aurelia/app-contacts

Repository files navigation

app-contacts

ZenHub Join the chat at https://gitter.im/aurelia/discuss

An Aurelia sample app that lets you browse and edit contacts.

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions, please join our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Machine Setup

This app is built on the Aurelia CLI, which has a couple of prerequisites you must install first. If you have previously setup your machine for the Aurelia CLI, you can skip this step.

  • Install NodeJS >= 4.x
  • Install NPM 3.x
    • Even though you may have the latest NodeJS, that doesn't mean you have the latest version of NPM. You can check your version with npm -v. If you need to update, run npm install npm -g.
  • Install a Git Client

Once you have the prerequisites installed, you can install the Aurelia CLI itself. From the command line, use npm to install the CLI globally:

npm install aurelia-cli -g

Note: Always run commands from a Bash prompt. Depending on your environment, you may need to use sudo when executing npm global installs.

Application Setup

Once you've setup your machine (or if it's been previous setup), you simply need to install the dependencies. From within the app-contacts folder, execute the following command:

npm install

Running The App

To run the app, execute the following command from within the app-contacts folder:

au run

See the CLI documentation for other available commands or type au help on the command line.