https://github.com/cfpb/grasshopper-ui
Front-end to Grasshopper, cfpb's nascent geocoder
https://github.com/cfpb/grasshopper-ui
Last synced: 5 months ago
JSON representation
Front-end to Grasshopper, cfpb's nascent geocoder
- Host: GitHub
- URL: https://github.com/cfpb/grasshopper-ui
- Owner: cfpb
- License: cc0-1.0
- Archived: true
- Created: 2015-02-18T19:16:58.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-07-28T15:49:23.000Z (10 months ago)
- Last Synced: 2025-07-28T17:41:07.235Z (10 months ago)
- Language: SCSS
- Homepage: https://github.com/cfpb/grasshopper
- Size: 961 KB
- Stars: 4
- Watchers: 19
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Grasshopper-UI
This is the front-end for [Grasshopper](https://github.com/cfpb/grasshopper), CFPB's work-in-progress geocoder.
Expect to be able to geocode individual addresses as well as batches of addresses from files or piped in from other APIs.
Our working prototype can be found running in [gh-pages](http://cfpb.github.io/grasshopper-ui/dist/)
## Dependencies
### Front-end
- Node
- Grunt
- [Mapbox.js](https://www.mapbox.com/mapbox.js/api/v2.1.5/) (for now)
## Installation
### Grunt
First run
```shell
$ npm install
```
To view the site run
```
$ grunt
```
The site should now be live at `http://localhost:9001`.
*It uses [grunt-contrib-connect](https://www.npmjs.com/package/grunt-contrib-connect), [grunt-connect-proxy](https://www.npmjs.com/package/grunt-connect-proxy) to handle the API call, and [connect-livereload](https://www.npmjs.com/package/connect-livereload).*
### Docker
Follow the Docker instructions in the [grasshopper repo](https://github.com/cfpb/grasshopper#docker).
**Note** - There is a dev setup for easier development.
## Known issues
We are still in the prototyping phase so there is a lot of ongoing work and errors could occur at anytime.
## Getting help
If you have questions, concerns, bug reports, etc, please file an issue in this repository's [Issue Tracker](https://github.com/cfpb/grasshopper-ui/issues).
## Getting involved
TBD
----
## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)