automuteus/web

The web dashboard of the AutoMuteUs Discord bot for Among Us.

AutoMute.us Web Application

Getting Started

To run this application in development:

yarn install
yarn dev

To run this application in production:

yarn install
yarn build
yarn start <PORT> # e.g. yarn start 8080

Environment Setup

To properly run this application, you need the following services and files:

• A PostgreSQL database with the schema defined in prisma/schema.prisma (TODO: have an .sql structure file here)
• A dot-env file configured in the root folder as .env containing the variables as outlined in .env.sample:

# JWT Secret
SECRET=

# NextAuth route base(s)
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_URL_INTERNAL=http://localhost:3000
NEXTAUTH_SECRET=

# Discord oAuth
DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET=

# Prisma DB connections
DATABASE_URL=
#SHADOW_DATABASE_URL=

# AutoMuteUs stats
GALACTUS_API=http://localhost:5000/bot/info

Additionally, you'll need to set up a valid callback URL in your Discord application registration (https://discord.com/developers) under "OAuth2" settings to match the pattern

<NEXTAUTH_URL>/api/auth/callback/discord

Deployment

This application is deployed using Docker. To build and run this application:

docker build -t automuteus .
docker run --name automuteus -dp <PORT>:3000 automuteus:latest

You can stop and remove this application container with

docker stop automuteus
docker rm automuteus

Note: The name automuteus in the above commands can be substituted with any name you prefer.

Planned Features

General Features

• Discord sign-in: sign in to the site with Discord OAuth2.

Web Dashboard

The web dashboard will allow configuration and control of instances of the hosted AutoMuteUs bot.

• Discord server invites: invite bot with specific link to servers that the user has admin permissions on
• Premium status checking: check to see if a guild you're in has premium.
• Settings management: edit bot configuration online and have it save, per server
  • Shareable settings: add ability to publish popular bot configs and share them
• Stats and leaderboards: view server stats and leaderboards in a more user-friendly manner than Discord embeds.
  • Raw stats exports: export files (permissively) of game data so that people can create their own visualizations and metrics.

web's Issues

The header for the sub-commands under `settings` is not correct

Thanks for your daily support :)

It's not so big deal, but I think the header for the sub-command under settings seems not correct.
For example they should start with /settings admin-user-ids instead of /admin-user-ids.

Seems following parent is not inherited to any sub-commands under settings.

web/pages/commands.tsx

Line 199 in 27240d2

parent={{ command: "settings" }}

It's a minor detail, but I created an issue just in case.

[TODO] Update help for new "/debug unmute" command