Skip to content

Commit

Permalink
📖 Improve README.
Browse files Browse the repository at this point in the history
  • Loading branch information
psbrandt committed Mar 10, 2016
1 parent 1af5f89 commit 21fd9f1
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions app/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ For further documentation about OpenMRS Open Web Apps see [the wiki page](https:

### Production Build

You will need NodeJS 4+ installed to do this. See the install instructions [here](https://nodejs.org/en/download/package-manager/).

Once you have NodeJS installed, you need to install Gulp and Bower (first time only) as follows:
````
npm install -g gulp bower
````

Install the dependencies (first time only):

```
npm install && bower install
```
Build the distributable using [Gulp](http://gulpjs.com/) as follows:

````
Expand All @@ -28,7 +40,14 @@ To deploy directly to your local Open Web Apps directory, run:
gulp deploy-local
````

This will build and deploy the app to the `<%= localDeployDirectory %>` directory. To change the deploy directory, edit the `LOCAL_OWA_FOLDER` variable in `gulpfile.js`.
This will build and deploy the app to the `<%= localDeployDirectory %>` directory. To change the deploy directory, edit the `LOCAL_OWA_FOLDER` entry in `config.json`. If this file
does not exists, create one in the root directory that looks like:

```js
{
"LOCAL_OWA_FOLDER": "/path/to/your/owa/directory"
}
```

### Extending

Expand All @@ -50,4 +69,4 @@ Any files that you add manually must be added in the `app` directory.

## License

[MPL 2.0 w/ HD](http://openmrs.org/license/) © [OpenMRS Inc.](http://www.openmrs.org/)
[MPL 2.0 w/ HD](http://openmrs.org/license/)

0 comments on commit 21fd9f1

Please sign in to comment.