Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 1.86 KB

README.md

File metadata and controls

77 lines (56 loc) · 1.86 KB
Raw

Tabuu 3.0 Dashboard

Simple dashboard for the Tabuu 3.0 Discord Bot.
Written in Vue and the server is powered by Rocket.

Prerequisites

Installation & Usage

Frontend

These steps take place in the ./frontend/ directory

  1. Set up the ./frontend/.env file
# The address to send requests to
VITE_API_URL = "http://127.0.0.1"
# The port to send requests to
VITE_API_PORT = "8080"
# The Discord OAuth2 URL.
# Visit your Application page and use the OAuth2 URL Generator.
# Check the "identify", "guilds" and "guilds.members.read" scopes.
# Make sure the response type is "token".
VITE_DISCORD_LOGIN_URL = "https://discord.com/api/oauth2/authorize?client_id=123456789&redirect_uri=http%3A%2F%2F127.0.0.1%3A80&response_type=token&scope=identify%20guilds.members.read%20guilds"
  1. Install dependencies
npm install
  1. Start the frontend
npm run dev -- --open

Backend

These steps take place in the ./server/ directory

  1. Set up the ./server/.env file
# The ID of the discord server
# Used to check for admin permissions
GUILD_ID = "1234567890"
# The Token of the bot, used for requests
DISCORD_TOKEN = "Example.Token"

# The address to listen on
ROCKET_ADDRESS = "127.0.0.1"
# The port to listen on
ROCKET_PORT = 8080
# The path to the sqlite database
ROCKET_DATABASE_URL = "/path/to/database.db"
  1. Start the backend server
cargo run --release

Packages used