Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/raczkodavid/Zooniverse/llms.txt

Use this file to discover all available pages before exploring further.

Zooniverse is a full-featured web application for zoo administrators and caretakers. It lets you create and manage animal enclosures, track resident animals with species-level detail, assign caretakers to specific enclosures, and enforce feeding schedules — all from a clean, role-aware dashboard.

Installation

Set up Zooniverse locally and get it running in minutes with the automated init script.

Default Users

Learn about the pre-seeded admin and caretaker accounts available after setup.

Enclosure Management

Create, edit, and monitor animal enclosures with capacity limits and feeding times.

Animal Management

Add animals to enclosures with smart validation for type compatibility and capacity.

User Roles

Understand the Admin and Caretaker roles, and what each can access and manage.

Animal Archiving

Soft-delete animals from the system and restore them to new enclosures when needed.

How it works

Zooniverse is organized around three core concepts: Enclosures, Animals, and Users (with two distinct roles).
  • Admins have full control — they create enclosures, add animals, assign caretakers, and manage archives.
  • Caretakers have read access to the enclosures they are assigned to, and can view feeding schedules and animal details.
  • Each enclosure has a name, an animal capacity limit, and a daily feeding time.
  • Each animal belongs to one enclosure and is classified as either a predator or herbivore. The system prevents incompatible animals from sharing an enclosure.
1

Install and set up

Clone the repository and run the init.bat script to install dependencies, create the database, and seed demo data.
2

Log in as admin

Use the default admin account (admin@admin.com / admin) to access the full management interface.
3

Create enclosures

Add enclosures with a name, maximum animal capacity, and feeding time.
4

Add animals

Populate each enclosure with animals, selecting their species, type (predator or herbivore), and birthdate.
5

Assign caretakers

Assign registered caretaker users to specific enclosures so they can view their assigned areas.
Zooniverse uses SQLite as its database, so no external database server is required during development.

Build docs developers (and LLMs) love