Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.08 KB

README.md

File metadata and controls

45 lines (35 loc) · 1.08 KB

GovRight Corpus Services

The govright.corpusServices module provides services for interacting with the models exposed by the LoopBack server via the REST API. Check the documentation for detailed API reference.

Usage

Add govright.corpusServices 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 corpus services script -->
   <script src="dist/govright-corpus-services.js"></script>
   <script>
     // ...and add 'govright.corpusServices' as a dependency
     var myApp = angular.module('myApp', ['govright.corpusServices']);
   </script>
 </head>
 <body></body>
</html>

Development

There are several gulp tasks available:

# 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