Skip to content

Commit

Permalink
Merge pull request #151 from Chicago/dev
Browse files Browse the repository at this point in the history
Merging with fixes to isse #135 and doc changes
  • Loading branch information
rladines committed Feb 5, 2016
2 parents 51d82c2 + 281d37e commit b766812
Show file tree
Hide file tree
Showing 15 changed files with 526 additions and 685 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
dist
node_modules
.idea
debug
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Download OpenGrid Code:
git clone https://github.com/Chicago/opengrid.git
```

After the initiate OpenGrid Code has been downloaded install the dependencies [Phantom JS](http://phantomjs.org/download.html) and [npm](https://www.npmjs.com/package/npm).
After the initial OpenGrid Code has been downloaded install the dependencies [Phantom JS](http://phantomjs.org/download.html) and [npm](https://www.npmjs.com/package/npm).

After the release package has been built deploy the files under the ./dist folder to your web server. For complete instructions on the entire process reference the [build procedures](https://github.com/Chicago/opengrid/blob/master/docs/Build%20Procedures.md) document.
After the release package has been built deploy the files under the ./dist folder to your web server. For complete instructions on the entire process reference the [build procedures](./Build%20Procedures/) document.

## Submit a bug

Expand Down
15 changes: 11 additions & 4 deletions docs/Installation and Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,14 @@
Once the application sources are downloaded and built, the distributable packages can be deployed to your web server (in case of the OpenGrid user interface) and application server (service layer).

Instructions for building the release packages can be found below:
* [User Interface Build Procedures](https://github.com/Chicago/opengrid/blob/master/docs/Build%20Procedures.md)
* [Service Layer Build Procedures](https://github.com/Chicago/opengrid-svc-template/blob/master/docs/Build%20Procedures.md)
<ul>
<li>
<a href="https://github.com/Chicago/opengrid/blob/master/docs/Build%20Procedures.md"> User Interface Build Procedures</a>
</li>
<li>
<a href="https://github.com/Chicago/opengrid-svc-template/blob/master/docs/Build%20Procedures.md">Service Layer Build Procedures</a>
</li>
</ul>

### Overview
#### Technical Requirements
Expand Down Expand Up @@ -34,8 +40,9 @@ By default, an admin user is created with user id 'admin' and password 'admin123
* Follow the steps described in the Service Layer Build Procedures above making sure that the application.properties file is updated with the appropriate MongoDB connection string. A war file is generated after the build process which can be deployed to an application server of your choice.

#### User Interface
* Update service URL to point to service URL configured above.
* Configure various application settings as required by your application by editing `src/js/custom/Config.js`. The settings include session timeout, area to limit address quick searches, to name a few. See [OpenGrid Configuration](./OpenGrid%20Configuration/) for more details
* Update service URL to point to service URL configured above by editing `config/EnvSettings.js`. `EnvSettings.js` is meant to contain settings that are environment-specific e.g. Dev, Qa or Production, etc. and overrides any settings as specified in `Config.js` mentioned above.

After a successful build as documented on the [User Interface Build Procedures](https://github.com/Chicago/opengrid/blob/master/docs/Build%20Procedures.md), a `/dist` folder is created with the files necessary for deployment to a web server. Copy all the files from the `/dist` folder, including sub-folders, to your application's root folder on the web server.
After a successful build as documented on the [User Interface Build Procedures](./Build%20Procedures/), a `/dist` folder is created with the files necessary for deployment to a web server. Copy all the files from the `/dist` folder, including sub-folders, to your application's root folder on the web server.


0 comments on commit b766812

Please sign in to comment.