-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# nyc-lib | ||
|
||
A set of common libraries used to develop NYC mapping applications | ||
|
||
### Geocoding | ||
|
||
* To use ```nyc.Geoclient``` as the implementation of ```nyc.Geocoder``` you must first get your Geoclient App ID and App Key from the [NYC Developer Portal](https://developer.cityofnewyork.us/api/geoclient-api) | ||
* Register if you don't have an NYC Developer Portal account | ||
* Developer Management > View or Create a New Project... | ||
* Configure [Gradle](http://gradle.org/) | ||
* Set ```git.geoclient.url='//maps.nyc.gov/geoclient/v1/search.json?app_key=YOUR_APP_KEY&app_id=YOUR_APP_ID'``` in ```$GRADLE_USER_HOME/gradle.properties``` | ||
* Set ```test.geoclient.url='//maps.nyc.gov/geoclient/v1/search.json?app_key={actual App Key}&app_id={actual App ID}'``` in ```$GRADLE_USER_HOME/gradle.properties``` | ||
|
||
## Tests | ||
* Run ```gradle jettyRun``` or ```gradlew jettyRun``` and navigate your browser to ```http://localhost:8088/src/main/test/``` to run [QUnit](https://qunitjs.com/) tests | ||
* To successfully run test ```nyc.Geocoder.search (address)``` you must configure [Gradle](http://gradle.org/) ass describe above | ||
|
||
## Build | ||
* ```gradlew buildLibs``` | ||
* builds libraries ```nyc-ol-lib.js```, ```nyc-ol-redline-lib.js```, ```nyc-leaf-lib.js```, ```nyc.carto-lib.js``` | ||
* ```gradlew jsDoc``` | ||
* builds [JsDoc](http://usejsdoc.org/) | ||
* ```gradlew archive``` | ||
* builds and zips libraries ```nyc-ol-lib.js```, ```nyc-ol-redline-lib.js```, ```nyc-leaf-lib.js```, ```nyc.carto-lib.js``` with [JsDoc](http://usejsdoc.org/) |