Volunteer Portal

This is the front-end code for the AnimeCon Volunteer Portal. It's written in TypeScript and depends on React, Material UI and various other packages that can be found in package.json.

Installation

Installing the volunteer portal for local development is straightforward, and does not require any dependencies external to those provided by this repository. Development can be done on any platform.

1. Clone the repository to a local directory.
2. Run the npm install command in this directory to pull in the dependencies.
3. Run the npm start command to start working from a local server. (With file watch.)

Deployment

TODO

API Requests

The volunteer portal requires a number of API calls in order to work properly. They can be provided by any back-end, but must follow certain documented semantics.

• /api/content
• /api/environment
• /api/login
• /api/event
• /api/registration
• /api/upload