Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.42 KB

DEVELOPER.md

File metadata and controls

31 lines (23 loc) · 1.42 KB

Developer Guide: Tux

Welcome to the Tux developer documentation!

This area provides in-depth information for developers working on Tux, beyond the initial setup and contribution workflow.

Getting Started & Contributing

For information on setting up your environment, the development workflow (branching, PRs), and basic quality checks, please refer to the main contribution guide:

Developer Topics

Explore the following pages for more detailed information on specific development aspects:

  • Local Development
    • Running the bot locally.
    • Understanding the hot reloading mechanism.
  • Tux CLI Usage
    • Understanding development vs. production modes (--dev, --prod).
    • Overview of command groups (bot, db, dev, docker).
  • Database Management
    • Detailed usage of tux db commands (push, migrate, generate, pull, reset).
    • Working with Prisma migrations.
  • Database Controller Patterns
    • Using controllers for CRUD, transactions, relations.
    • Best practices for database interactions in code.
  • Docker Environment (Optional)
    • Setting up and using the Docker-based development environment.
    • Running commands within Docker containers.