Skip to content

About

Official website for Wolfstar

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

3,022 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
WolfStar Logo

WolfStar.rocks

The official web dashboard for WolfStar, a Discord moderation bot.

Official Site Β· Blog Β· WolfStar Invite Link Β· Support Server Β· Feedback

GitHub latest release badge GitHub last commit badge
Discord community badge Codecov coverage badge GitHub contributors badge
GitHub forks badge GitHub stars badge GitHub issues badge GitHub license badge
PRs welcome badge

Share WolfStar Repository

Pioneering the new age of server moderation management. Built for you, the Super Admin.

Table of contents

Table of Contents


πŸ‘‹πŸ» Welcome to WolfStar.rocks

WolfStar.rocks is the official web dashboard for WolfStar, a Discord moderation bot. It gives your team one place to configure filters and server settings, and to review moderation, command, and settings history.

✨ Features

  • Modern Web Interface: Built with Nuxt 4 and modern web technologies for a smooth user experience.
  • Server Management: Manage your Discord server's settings, roles, and permissions through an intuitive web interface.
  • Responsive Design: Works seamlessly on desktop, tablet, and mobile devices.
  • OAuth Integration: Secure Discord authentication and authorization.
  • Audit Trail: Dashboard settings changes and denied access attempts are recorded in a tamper-evident audit log. Each event is persisted to PostgreSQL with a SHA-256 hash chain, and pnpm audit:verify replays the chain to verify it.
  • Multi-language Dashboard: The dashboard is translated through Tolgee, and /translation-status shows how far each language has come.
  • Accessibility: Built with semantic HTML, keyboard navigation, and reduced-motion support.

On the roadmap

  • Real-time Updates: Live updates for guild data and bot status.
  • Dashboard Analytics: Server statistics and bot usage metrics.

πŸš€ Self-Hosting WolfStar.rocks Requirements

  • Node.js: WolfStar.rocks is built on Node.js, so you will need to have Node.js (v24+) installed.
  • WolfStar Bot: You need a running instance of WolfStar bot to connect this dashboard to.
  • Discord Bot Application: A Discord bot application with proper OAuth2 configuration.
  • PostgreSQL: PostgreSQL database (shared with WolfStar bot instance).

πŸ›³ Self-Hosting WolfStar.rocks

Quick Setup

  1. Clone the repository

    git clone https://github.com/wolfstar-project/wolfstar.rocks.git
    cd wolfstar.rocks
  2. Install dependencies

    pnpm install
  3. Environment Configuration

    • Duplicate .env.example and rename it to .env.
    • Fill in all required environment variables.
    • Configure Discord OAuth2 settings in your Discord Developer Portal.
  4. Database Setup

    • Ensure your WolfStar bot database is accessible. The bot owns the schema and applies its migrations; this app never migrates the database.
    • The data contract lives in the bot's repository, vendored as a git submodule. pnpm install checks it out and emits the Prisma ORM 8 artefacts; clone with --recurse-submodules to fetch it up front.
  5. Start the development server

    pnpm dev

Environment Variables

  1. Duplicate .env.example and rename it to .env.
  2. Fill in all required environment variables.
  3. Configure Discord OAuth2 settings in your Discord Developer Portal.

Discord OAuth2 Configuration

  1. Go to the Discord Developer Portal.
  2. Select your bot application.
  3. Navigate to the OAuth2 tab.
  4. Add redirect URLs:
    • http://localhost:3000/oauth/callback
    • http://localhost:3000/oauth/guild
  5. Save your changes.

Available Scripts

  • pnpm dev - Start development server.
  • pnpm dev:pwa - Start development server with PWA support.
  • pnpm build - Build for production.
  • pnpm preview - Preview production build.
  • pnpm lint:fix - Run Oxlint & Oxfmt and fix issues.
  • pnpm prisma:generate - Emit the Prisma ORM 8 contract artefacts into server/database/generated/prisma/. The contract comes from the bot's repository, vendored as the vendor/wolfstar git submodule; run this again after bumping it.
  • pnpm test - Run all tests.
  • pnpm test:unit - Run unit tests.
  • pnpm test:nuxt - Run Nuxt environment tests.
  • pnpm test:browser - Run browser tests with Playwright.
  • pnpm typecheck - Run TypeScript checks.

Occasional one-off tasks are not wrapped in package.json. Run their binary directly instead:

  • pnpm exec prisma skills sync - Refresh the vendored Prisma 8 reference docs.
  • pnpm exec pwa-assets-generator - Generate PWA icons and assets.
  • pnpm exec taze - Interactive dependency updates.

Testing

Running Tests

  • pnpm test - Run all tests with Vitest
  • pnpm test:unit - Run unit tests only (Node.js environment)
  • pnpm test:nuxt - Run Nuxt component tests (Nuxt environment with browser)
  • pnpm test:browser - Run full browser E2E tests with Playwright

Development Guidelines

  • Follow the existing code style and conventions.
  • Write clear, descriptive commit messages.
  • Add tests for new features.
  • Update documentation as needed.
  • Ensure all CI checks pass.

Development Tools

  • Nuxt 4 - Vue.js framework
  • TypeScript - Type safety
  • Oxlint - Code linting
  • Oxfmt - Code formatting
  • Prisma ORM 8 - Database client (the WolfStar bot owns the schema and its migrations; this app consumes the same data contract)
  • Tailwind CSS - Utility-first CSS framework
  • Nuxt UI - Vue component library and design tokens

AI Development Assistant

  • Custom GitHub Copilot Agent - Specialized WolfStar development agent with Context7 MCP integration (see .github/agents/wolfstar-dev-agent.md).
  • Autonomous Problem-Solving - Beast Mode with iterative refinement.
  • Real-time Documentation - Up-to-date library docs via Context7.
  • Quality First - Integrated Oxlint, Sentry, and testing workflows.

⌨️ Local Development

Refer to CONTRIBUTING.md for detailed setup instructions.

πŸ’» Online Development

Click any of the buttons below to start a new development environment to demo or contribute to the codebase without having to install anything on your machine:

Open in VS Code Open in GitHub1s Open in GitHub Codespaces Open in StackBlitz Edit in Codesandbox Open in Codeanywhere Build with Ona

🀝 Contributing

Thank you to all the people who already contributed to WolfStar.rocks! Please make sure to read the Contributing Guide before making a pull request.

Project contributors

❀️ Sponsor

If you like WolfStar and want to support the project, consider making a donation. Every contribution helps to maintain and improve the bot.

Support on Ko-fi Support on Patreon Sponsor on GitHub

Thank you for your support!


Back to top


πŸ“ License

Copyright Β© 2024 WolfStar.
This project is Apache 2.0 licensed.

About

Official website for Wolfstar

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages