|
| 1 | +# WrenchJS |
| 2 | + |
| 3 | +Hey there! |
| 4 | + |
| 5 | +So you want to play around with wrenchjs? |
| 6 | + |
| 7 | +It's easy. To set up the project on your machine, run these commands: |
| 8 | +```bash |
| 9 | +# Get the source code on your machine |
| 10 | +git clone git@github.com:rodyhaddad/wrenchjs.git; |
| 11 | +# Step inside the project |
| 12 | +cd wrenchjs; |
| 13 | +# Install the project dependency |
| 14 | +npm install; |
| 15 | +# Creates a global link, and exposes the bins of the project |
| 16 | +npm link; |
| 17 | +``` |
| 18 | + |
| 19 | +After you ran that, you now have a `wrenchjs` command line tool! It has the same interface as ember-cli for now. |
| 20 | + |
| 21 | +You can use it to generate new projects, build them, serve them and so on. |
| 22 | + |
| 23 | +But the stuff that are already provided are tailored for Ember projects. |
| 24 | +You probably want it for Angular, and that's why you're playing with this! |
| 25 | + |
| 26 | +You most likely want to develop new blueprints and addons. |
| 27 | + |
| 28 | +To do that, copy the existing dummy-addon or dummy-blueprint. |
| 29 | + |
| 30 | +If you want to know more about blueprints, check [here](https://github.com/ember-cli/ember-cli/blob/master/lib/models/blueprint.js#L37). |
| 31 | +If you want to know more about addons, check [here](https://github.com/ember-cli/ember-cli/blob/master/ADDON_HOOKS.md) and [here](http://www.ember-cli.com/#developing-addons-and-blueprints). |
| 32 | + |
| 33 | +Since wrenchjs is a customized proxy to wrenchjs, you can check the [existing ember-cli addons](http://www.emberaddons.com/) to get inspired. |
| 34 | + |
| 35 | +If you're curious, to have addons discovered by the `wrenchjs` cli tool, they either need to: |
| 36 | + |
| 37 | +* Be in the `addon` directory of the project |
| 38 | +* As a npm dependency to wrenchjs |
| 39 | +* As a npm dependency to any "wrenchjs" project (meaning you're using `wrenchjs` in that project directory) |
| 40 | + |
| 41 | +Addons should still use the `ember-addon` keyword in their package.json to get discovered for now. |
| 42 | + |
| 43 | +If you have any questions, please let me know :-) |
0 commit comments