Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nycplanning/labs-cyclomedia-service
A simple web service that shows a fullscreen cyclomedia viewer for a given lat/lon pair
https://github.com/nycplanning/labs-cyclomedia-service
cyclomedia labs node
Last synced: 12 days ago
JSON representation
A simple web service that shows a fullscreen cyclomedia viewer for a given lat/lon pair
- Host: GitHub
- URL: https://github.com/nycplanning/labs-cyclomedia-service
- Owner: NYCPlanning
- Created: 2017-11-24T22:21:07.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-10T19:46:55.000Z (26 days ago)
- Last Synced: 2024-12-10T20:35:40.745Z (26 days ago)
- Topics: cyclomedia, labs, node
- Language: JavaScript
- Homepage:
- Size: 3.78 MB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# labs-cyclomedia-service
A simple web service that shows a fullscreen cyclomedia viewer for a given set of coordinates. This requires access to you or your organization's [Cyclomedia](https://www.cyclomedia.com) API credentials (including username, password, and API key).
## How we work
[NYC Planning Labs](https://planninglabs.nyc) takes on a single project at a time, working closely with our customers from concept to delivery in a matter of weeks. We conduct regular maintenance between larger projects.
## How you can help
In the spirit of free software, everyone is encouraged to help improve this project. Here are some ways you can contribute.
- Comment on or clarify [issues](link to issues)
- Report [bugs](link to bugs)
- Suggest new features
- Write or edit documentation
- Write code (no patch is too small)
- Fix typos
- Add comments
- Clean up code
- Add new features
## Requirements
You will need the following things properly installed on your computer.
* [Git](https://git-scm.com/)
* [Node.js](https://nodejs.org/) (with NPM)
## Local development
- Clone this repo `git clone https://github.com/NYCPlanning/labs-cyclomedia-service.git`
- Install Dependencies `npm install`
- Run `touch .env`
- Open `.env-template` in a text editor of your choice
- Fill in the correct values for your Cyclomedia credentials
- Rename file to `.env`
- Start the server `npm start`
- Visit `localhost:3000/view/{lat}/{lon}`
## Architecture
This is a simple microservice originally intended to be embedded in https://github.com/NYCPlanning/labs-zola. It merely serves out an HTML page containing the Cyclomedia Javascript Application configured to whatever parameters specified in the route. It uses the [Jade](http://jade-lang.com/) templating syntax.
### Backend services
- **[Cyclomedia](https://www.cyclomedia.com)** - Provides interactive street imagery
## Testing and checks
- None yet - we should have ESLint setup at some point to clean up the Javascript. Testing would be nice, but this is an unconventional app with low complexity.
## Deployment
App can be deployed through `git` pushing it to a Dokku app.
## Contact us
You can find us on Twitter at [@nycplanninglabs](https://twitter.com/nycplanninglabs), or comment on issues and we'll follow up as soon as we can. If you'd like to send an email, use [[email protected]](mailto:[email protected])
## Credits
Special thanks to [Andy Rothwell](https://github.com/ajrothwell) at the [City of Philadelphia](https://github.com/CityOfPhiladelphia) for providing advice on their approach to using this API publicly.