API subproject for the Simplification Election Procedures team. This API simply stores a WebID and returns a list of stored WebIDs, which can be used to fetch Solid documents.
To run this project as a development server, you will need docker-compose. You will also need to set some environment variables, the easiest way to do this is to create an .env file (format VARIABLE=value) in the project root.
- DEBUG - Setting this to any value (including
0orFalse) will enable Sanic's debug mode, which gives you hot-reload functionality and more verbose error logging. Please don't enable this in production. - PG_HOST - The host of the Postgres instance. Default:
db - PG_DBNAME - Name of Postgres database. Default:
postgres - PG_USER - Name of Postgres user. Default:
postgres - PG_PASS - Password to use for this user. Run
pwgen 30 1 -sto generate a random password. - SPARQL_URL - URL for the Virtuoso SPARQL endpoint. Default:
http://api.sep.osoc.be:8890/sparql
To deploy the production stack, you need to set up a Docker Swarm instance, as described here. First copy the docker-compose-prod.yml file from this repository to your instance. Then create a pgdata folder for persistent database storage, a virtuoso-data folder for Virtuoso's triple storage and a letsencrypt to store the TLS certificates generated for Traefik.
Now set the environment variables in an .env file as described above, plus a HOST variable with the domain name and LETSENCRYPT_EMAIL for the e-mail address you want to use for Let's Encrypt (for expiration warnings).
# To deploy the stack
env $(cat .env | xargs) docker stack deploy -c docker-compose-prod.yml solid-elections-api
# To update the API container (you can set this up as a webhook) - you can also just run the above command again instead
docker service update --image solidelections/api solid-elections-api_apiDocumentation about the api is automatically generated and is available at ./swagger when the server is running. See their documentation for info on how to modify the api documentation.