Caution

This repository will no longer be maintained; check out the AnimeCon Volunteer Manager instead.

AnimeCon 2021 Volunteer Portal (backend)

This repository contains a Volunteer Portal backend implementation for the AnimeCon 2021 festival. The frontend may be found in the volunteer-portal project, also published on GitHub.

This project has been designed specifically for AnimeCon, and will not consider contributions that are not immediately applicable to AnimeCon.

API-driven communication

The frontend and backend communicate with each other through a set of APIs, each of which share serve.php as their entry point, which then delegates to Api.php for actual functionality.

Installation

In order to run this service, you will need access to a server that supports PHP 8.0.2 or later. After checking out this respository and executing composer install, follow these steps:

1. Grant read/write permissions to the api/cache/ directory for the webserver.
2. Create a api/configuration/configuration.json5 file based on the example.
3. Create a api/configuration/google-credentials.json file containing Google authorization credentials.
4. Run api/google-auth.php on the CLI to establish an authorization token.
5. Set up api/services/execute.php to be executed every minute using a cronjob.