@resin/pinejs/docs/Building.md

Pine.js is a sophisticated rules-driven API engine that enables you to define rules in a structured subset of English. Those rules are used in order for Pine.js to generate a database schema and the associated [OData](http://www.odata.org/) API. This make

# Building from Source

Pine.js can be distributed as a single javascript file
typically named `pine.js` which contains aggregated code capable of reading an SBVR file and generating an API. Configuration is read from `config.json` in the same directory as `pine.js` and described further in [project configuration document][project-config].

## Requirements
* [node.js](https://nodejs.org) >= 0.8.18
* [require.js](http://requirejs.org) >= 2.1.4 (`npm install -g requirejs`)
* [node-bcrypt dependencies](https://github.com/ncb000gt/node.bcrypt.js/#dependencies)

The required steps to build Pine.js are:

1. Check out (or update your copy of) `pinejs/master` (all paths below will be relative to this working directory unless otherwise specified).
2. Run `bower install` in the root of pinejs.
3. Run `npm install` in the root of pinejs.
4. Run `./node_modules/.bin/grunt $TYPE -o server.build.js` on Linux/Mac OSX or `node_modules\.bin\grunt $TYPE` on Windows, where `$TYPE` is `server` or `module`.

Pine.js used to be copied to other projects as a single built file. This is no longer required, since it is a proper npm module. So, if you want to start a project with Pine.js you just need to include it as a dependency in your package.json:

```
"dependencies": {
    "@resin/pinejs": "^2.0.0",
```


## Example Application

The [Pine.js Example Application][pine-example] is the best means of getting up to speed with Pine.js and the [Pine.js API][pinejs-client-js] (a library for interacting with Pine.js simply from the frontend) - it contains an end-to-end working 'ToDo' web application.


## Contributors

You can use `grunt` to build the project when working directly on pine, this is useful to test some changes locally before submitting a PR.
If you are using pine bundled into a single js file, you can simply run step 4 from the build again to obtain the new file.
The entry-point for the npm module is located at `out/server-glue/module.js`, you can test your local changes by running `grunt build`, which will build all files in the `src/` folder and copy the output to `out/`.
You can also specify a different target folder in which to build Pine.js via the following command `grunt build --target=path-to-your-pinejs-dependency/out`.

[docs]:.
[pine-example]:https://github.com/resin-io/pine-example
[pinejs-client-js]:https://github.com/resin-io/pinejs-client-js
[project-config]:ProjectConfig.md