1
0
Fork 0
mirror of https://codeberg.org/demostf/api.git synced 2026-06-03 09:54:17 +02:00
REST api for demos.tf
  • PHP 87.4%
  • Nix 8.3%
  • JavaScript 3.4%
  • Makefile 0.5%
  • Dockerfile 0.4%
Find a file
2017-04-13 00:34:48 +02:00
src apc -> apcu 2017-04-13 00:15:05 +02:00
tests upload and tests 2017-04-10 00:58:50 +02:00
.dockerignore upload framework 2017-03-20 21:51:03 +01:00
.gitignore import 2016-12-04 01:17:46 +01:00
.travis.yml travis config 2017-04-08 17:41:03 +02:00
composer.json fix dockerfile 2017-04-11 22:41:05 +02:00
composer.lock upload framework 2017-03-20 21:51:03 +01:00
Dockerfile fix dockerfile 2017-04-11 22:41:05 +02:00
Makefile upload framework 2017-03-20 21:51:03 +01:00
README.md update readme 2017-04-13 00:34:48 +02:00

demos.tf api

Build Status codecov

Backend code for demos.tf

Database

The api requires a PostgreSQL database to function, the database schema required can be found in demostf/db/demos_schema.sql.

Note that the pg_trgrm extension in required.

Docker image

A prebuild docker image exists in the docker hub which contains nginx, php and this code.

A seperate PostgreSQL database is required to run the image, the database details need to be configured with the following environment variables:

  • DB_TYPE=pgsql
  • DB_HOST=$database_host
  • DB_DATABASE=$database_name
  • DB_USERNAME=$database_user
  • DB_PASSWORD=$database_password
  • BASE_HOST=$host
  • PARSER_URL=$parser_host // the full url for the demo parser's upload endpoint

Installing

To install the project composer is required.

composer install

Deploying

Deploying the api requires php7.1 or later, the webserver needs to be configured to server all requests to public/index.php execept for request to /upload which needs to be handled by public/upload.php.

The database details need to be configured with the same environment variables as are described for the docker image above.

More information for hosting and a pre-configured docker based setup can be found at demostf/setup