Skip to content

Services that encapsulate common techniques of interacting with GovRight Corpus REST API

License

Notifications You must be signed in to change notification settings

GovRight/platform-services

Repository files navigation

GovRight Platform Services

The govright.platformServices module provides services that encapsulate common techniques of interacting with the GovRight Corpus API. Check the documentation for detailed API reference.

Usage

Add govright.platformServices module as a dependency to your main application module. Example:

<!doctype html>
<html ng-app="myApp">
 <head>
   <script src="js/angular.js"></script>
   <!-- Include the platform services script -->
   <script src="dist/govright-platform-services.js"></script>
   <script>
     // ...and add 'govright.platformServices' as a dependency
     var myApp = angular.module('myApp', ['govright.platformServices']);
   </script>
 </head>
 <body></body>
</html>

This will add the following services to your app:

Further reading

Development

First install your local project's npm tools:

# This will install all the npm & bower packages:
npm install

Then run the gulp tasks:

# To build packaged js files from sources
gulp js

# To build html documentation from source ngdocs
# Changes must be commited on `gh-pages` branch
gulp docs

# To run local documentation server
gulp serve

# Build dist and docs
gulp

Finally, test the package:

# To run tests from `/test/specs` with npm
npm test

About

Services that encapsulate common techniques of interacting with GovRight Corpus REST API

Resources

License

Stars

Watchers

Forks

Packages

No packages published