Skip to content

Latest commit

 

History

History
39 lines (22 loc) · 1.49 KB

README.md

File metadata and controls

39 lines (22 loc) · 1.49 KB

A new searchable interface for New York Open Data (or any socrata data portal)

screenshot

Introducing scout, an open source browser-based tool that eases the discovery and curation of thematically related and joinable datasets to broaden the application of open data to uncover new insights.

Scout is designed to help surface datasets in the NYC Open Data Portal that might have escaped your attention before.

Try it out here

Contributing

We love all contributions, be it a bug report or feature request via a GitHub issue, or feedback over email

Roadmap

We will maintain a 6 month roadmap which you can read here: roadmap. If you want clarification on the roadmap or have suggestions or other comments, please open an issue.

Development

If you want to help with the development of scout, you will need to be able to run the code locally. Scout is built using React and for development we use yarn.

To get started install yarn and then run the following in a terminal:

yarn

Once that is done simply run the folowing to start the development server:

yarn start

Socrata Data Discovery API

Main data source for the project is the Socrata Data Discovery API. API docs live here:

https://socratadiscovery.docs.apiary.io/#