Skip to content

opendatacity/re-data

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

re-data

This project is the ongoing effort of providing an simple JSON API interface for conferences and under heavy development.

Example data includes re:publica, 30C3, 31C3. Take a look at the scrapers directory.

Documentation

Documentation on the API can be found here

Contributing

The infrastructure is still very rough as this is a side project of several people. If you are interested in helping out, send pull requests or join the mailing list.

Examples

Set it up locally

  • you need a CouchDB instance (use for example a docker container to set on up easily)
    • docker run -d -p 5984:5984 fedora/couchdb
    • curl -X PUT http://localhost:5984/_config/admins/user -d '"secret"' (creates user user with password secret)
  • copy config.js.dist to config.js and fill in the credentials for the CouchDB instance (see curl step above)
  • copy scraper/config/scrapers.js.example to scraper/config/scrapers.js (default config is fine for a first run)
  • fetch dependencies via npm (needs to be executed in scraper subdirectory):
    • npm install
  • run the resetDB command inside the scraper subdirectory:
    • NODE_PATH=node_modules node scraper.js resetDB (NODE_PATH just specifies not globally install locations - was created by the npm install step)
  • run the import command inside the scraper subdirectory:
    • NODE_PATH=node_modules node scraper.js import