Stoat Admin Panel

Dashboard containing tools to handle platform administration

Important

This admin panel is very much a work in progress, and support won't be offered unless you contribute financially or via code, as we are currently very much resource constrained.

Development Guide

Before contributing, make yourself familiar with our contribution guidelines.

Before getting started, you'll want to install:

• Bun
• Docker
• Git

A default.nix is available for Nix users! Just run nix-shell and continue.

Now you can clone and run the project:

git clone --recursive https://github.com/revoltchat/admin-panel
cd admin-panel
bun install

Then copy .env.local.example to .env.local and fill it out with the relevant information.

bun run dev

Deployment Guide

bun install

Then copy .env.local.example to .env.local and fill it out with the relevant information.

bun run build
bun run start

License

The Stoat admin panel is generally licensed under the GNU Affero General Public License v3.0.