Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automuteus/web
The web dashboard of the AutoMuteUs Discord bot for Among Us.
https://github.com/automuteus/web
leaderboards oauth2 premium stats web-dashboard
Last synced: about 7 hours ago
JSON representation
The web dashboard of the AutoMuteUs Discord bot for Among Us.
- Host: GitHub
- URL: https://github.com/automuteus/web
- Owner: automuteus
- Created: 2020-12-02T02:00:58.000Z (almost 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-07-20T20:00:42.000Z (over 1 year ago)
- Last Synced: 2023-07-20T21:30:56.745Z (over 1 year ago)
- Topics: leaderboards, oauth2, premium, stats, web-dashboard
- Language: TypeScript
- Homepage: https://automute.us
- Size: 23.6 MB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AutoMute.us Web Application
## Getting Started
To run this application in development:
```bash
yarn install
yarn dev
```
To run this application in production:
```bash
yarn install
yarn build
yarn start # 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`:
```bash
# 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
```
/api/auth/callback/discord
```
## Deployment
This application is deployed using Docker. To build and run this application:
```bash
docker build -t automuteus .
docker run --name automuteus -dp :3000 automuteus:latest
```
You can stop and remove this application container with
```bash
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
- [x] **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.