Skip to content

Commit

Permalink
🎬 Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
psbrandt committed Jan 29, 2016
0 parents commit 7055ea5
Show file tree
Hide file tree
Showing 22 changed files with 1,285 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
15 changes: 15 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"node": true,
"esnext": true,
"mocha": true,
"bitwise": false,
"curly": false,
"eqeqeq": true,
"eqnull": true,
"immed": true,
"latedef": true,
"newcap": true,
"noarg": true,
"undef": true,
"strict": false
}
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sudo: false
language: node_js
node_js:
- '4'
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<img src="https://cloud.githubusercontent.com/assets/668093/12567089/0ac42774-c372-11e5-97eb-00baf0fccc37.jpg" alt="OpenMRS"/>

# OpenMRS Open Web App Generator [![Build Status](https://secure.travis-ci.org/psbrandt/generator-openmrs-owa.svg?branch=master)](http://travis-ci.org/psbrandt/generator-openmrs-owa)

> [Yeoman](http://yeoman.io) generator that scaffolds an [OpenMRS Open Web App](https://wiki.openmrs.org/display/docs/Open+Web+Apps+Module)
[![OpenMRS OWA Asciicast](https://asciinema.org/a/35039.png)](https://asciinema.org/a/35039?autoplay=1)

## Features

The following features are currently supported:

- [x] Scaffold basic OWS folder structure and files
- [x] Production build with [Gulp](http://gulpjs.com/)
- [x] Local deploy with Gulp
- [x] Package management with [Bower](http://bower.io/)

## Getting Started

- Install dependencies: `npm install --global yo gulp bower`
- Install the generator: `npm install --global generator-openmrs-owa`
- Create directory for your app: `mkdir openmrs-owa-myapp && cd $_`
- Run `yo openmrs-owa` to scaffold the Open Web App
- Run `gulp` to build distributable zip file
- Run `gulp deploy-local` to deploy directly to your local server

## Extending

Install Bower packages dependencies as follows:

````
bower install --save <package>
````

Be sure to include the following in your `html` files at the position you want the Bower dependencies injected:

````
<!-- bower:js -->
<!-- endbower -->
````
Do the same for your Bower stylesheet dependencies, but replace `js` with `css`.

Any files that you add manually must be added in the `app` directory.

## Options

- `--skip-welcome-message` Skips Yeoman's greeting before displaying options.
- `--skip-install` Skips automatically running `bower` and `npm`.

## Environment Variables

The generator will read the following environment variables and use their values as the default when generating a new Open Web App:

- `OMRS_OWA_LOCAL_DIR`: The directory to use for local deployment
- `OMRS_OWA_GITHUB_ID`: Your GitHub username

## Contribute

See the [contributing docs](https://github.com/yeoman/yeoman/blob/master/contributing.md).

## Support

It's best to ask your questions on [OpenMRS talk](https://talk.openmrs.org/tags/c/software/javascript).

## License

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

0 comments on commit 7055ea5

Please sign in to comment.