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-08 17:55:53 +02:00
src demo list tests and fixes 2017-04-08 15:43:32 +02:00
tests fix code coverage 2017-04-08 17:55:53 +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 upload framework 2017-03-20 21:51:03 +01:00
composer.lock upload framework 2017-03-20 21:51:03 +01:00
Dockerfile upload framework 2017-03-20 21:51:03 +01:00
Makefile upload framework 2017-03-20 21:51:03 +01:00
README.md readme 2017-04-08 17:44:16 +02:00

demos.tf api

Backend code for demos.tf

WIP

This repo is still somewhat wip and might not be in the state yet where it can deployed outside of the existing demos.tf environment.

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

Installing

To install the project composer is required.

composer install

Deploying

Deploying the api requires php5.6 or later, the webserver needs to be configured to server all requests to public/index.php

The database details need to be configured with the same environment variables as are described for the docker image above. The environment variables can also be be put in a .env file in the root of the project.