Generates API documentation for a dataset hosted on carto. Inspired by Socrata's API Foundry, this application queries Carto's API to get field names, types, and example values, then generates a page with usage examples and basic documentation.
Work in progress. View the demo.
Also note this is my (@timwis) first time using MobX so please let us know if there are any suggestions!
- Install dependencies via
npm installoryarn install - Copy
.env.sampleto.envand modify configuration as necessary - Run a development server using
npm startoryarn start - Generate the documentation for a table by adding '/#' followed by the table name to the end of the URL. Example for a table called
tabletest:/#tabletest