diff --git a/README.md b/README.md new file mode 100644 index 0000000..259144a --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# hoodie-admin + +> Hoodie Admin core module + +[![Build Status](https://travis-ci.org/hoodiehq/hoodie-admin.svg?branch=master)](https://travis-ci.org/hoodiehq/hoodie-admin) +[![Dependency Status](https://david-dm.org/hoodiehq/hoodie-admin.svg)](https://david-dm.org/hoodiehq/hoodie-admin) +[![devDependency Status](https://david-dm.org/hoodiehq/hoodie-admin/dev-status.svg)](https://david-dm.org/hoodiehq/hoodie-admin#info=devDependencies) + +This is the admin UI for [Hoodie](http://hood.ie) applications. It’s build with +[Ember.js](http://emberjs.com/) and embraces Ember’s convention above Hoodie’s +to make it as natural for Ember developers to contribute to it as possible. + +## Prerequisites + +You will need the following things properly installed on your computer. + +* [Git](http://git-scm.com/) +* [Node.js](http://nodejs.org/) (with NPM) +* [Bower](http://bower.io/) +* [Ember CLI](http://ember-cli.com/) +* [PhantomJS](http://phantomjs.org/) + +## Installation + +* `git clone ` this repository +* change into the new directory +* `npm install` +* `bower install` + +## Running / Development + +* `ember server` +* Visit your app at [http://localhost:4200](http://localhost:4200). + +### Code Generators + +Make use of the many generators for code, try `ember help generate` for more details + +### Running Tests + +* `ember test` +* `ember test --server` + +### Building + +* `ember build` (development) +* `ember build --environment production` (production) + +### Deploying + +Specify what it takes to deploy your app. + +## Further Reading / Useful Links + +* [ember.js](http://emberjs.com/) +* [ember-cli](http://ember-cli.com/) +* Development Browser Extensions + * [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi) + * [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/) + +## Contributing + +Have a look at the Hoodie project's [contribution guidelines](https://github.com/hoodiehq/hoodie/blob/master/CONTRIBUTING.md). +If you want to hang out you can join our [Hoodie Community Chat](http://hood.ie/chat/). + +## License + +[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)