API Specification

Database Specification

To start a development instance, install docker and docker-compose and run:

docker-compose --profile dev up

(requires docker-compose v1.29)

This will start containers for:

• The main API (on localhost:8080)
• Postgres database
• RabbitMQ messaging
• System daemons:
  • results recorder
  • whois checker
  • category importer
  • metadata gatherer
  • robots.txt checker
• Example web client (on localhost:8081)

You can use the example web client by visiting http://localhost:8081/example-client/

The postgres database is loaded with the main schema, as well as some example data to get started.

We welcome new contributors especially - we hope you find getting involved both easy and fun. All you need to get started is a github account.

Please see our issues repository for details on how to join in.

We reused the following software components to make this:

• @ircmaxell's password compatibility library (MIT license).
• The Symfony2 PHP web development framework (MIT license).
• The Silex PHP micro-framework to develop websites based on Symfony2 components (MIT license).
• The PostgreSQL database (PostgreSQL license).
• php-amqp from pecl (PHP license).
• RabbitMQ (Mozilla Public License 1.1)

Thanks!