Skip to content
This repository has been archived by the owner on Jan 14, 2020. It is now read-only.

Latest commit

 

History

History
73 lines (45 loc) · 2.17 KB

README.md

File metadata and controls

73 lines (45 loc) · 2.17 KB
Raw

angular-nav-data

Deprecated: This repository has been deprecated together with https://github.com/fielded/nav-integrated-state-dashboard.

Build Status Dependecy Status Dev Dependecy Status

Config

In your Angular module provide the url for the remote CouchDB database as dataModuleRemoteDB.

Example:

.factory('dataModuleRemoteDB', function (config) {
  return config.couchDB + config.integratedDataRemoteDB
})

Installation

Install with bower:

bower install --save fielded/angular-nav-data

or npm:

npm install --save fielded/angular-nav-data

Then simply add angularNavData as a dependency somewhere in your project that makes sense and you're good to go.

Contributing

Installation

# Clone the GitHub repository
git clone [email protected]:fielded/angular-nav-data.git
# Change into project folder
cd angular-nav-data
# Install the dev dependencies
npm install

Test Suite

The test suite is configured to run with PhantomJS and is powered by:

  • Karma
  • Jasmine

Running Tests

npm test

To run the integration tests:

  1. Enable CORS on your CouchDB
  2. If you have admin party enabled, run npm t (there is no step 3)
  3. Run COUCHDB_URL=http://[user:pass@]example.com npm t

Release Process

To make a release, you need to run npm run build, commit the dist folder and tag the commit with an appropiate version according to the SemVer spec.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.