MoltenCore

The last Discord bot you'll ever need with Plugins and Dashboard

Documentation · Report Bug · Request Feature

📔 Table of Contents

• 📔 Table of Contents
• ❗UNDER HEAVY DEVELOPMENT❗
  • 🌟 About the Project
    • 📷 Screenshots
    • 🛰️ Tech Stack
    • 🎯 Features
    • 🔑 Environment Variables
  • 🧰 Getting Started
    • 🐳 Docker setup
      • Windows
      • Linux
    • 🏃 Running locally
      • 🚩 Bot + Backend + Compiled frontend
      • 🚩 Frontend in development mode
    • 🧪 Running Tests
  • 👋 Contributing
    • 📜 Code of Conduct
  • ⚠️ License
  • 🤝 Contact
  • 💎 Acknowledgements

❗UNDER HEAVY DEVELOPMENT❗

🌟 About the Project

📷 Screenshots

🛰️ Tech Stack

Client

• Typescript
• Vue.js
• NaiveUI
• Ionicons

Server

• Python
• FastAPI
• SQLModel
• Alembic

Database

• PostgreSQL

DevOps

• Docker
• GitHub Actions
• GitHub Pages
• VitePress

🎯 Features

• Install whatever plugins you want, no bloat
• Easy install with Docker
• Dashboard to manage your bot and plugins

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

DISCORD_BOT_TOKEN

🧰 Getting Started

🐳 Docker setup

Copy just the docker-compose.yml and compose-alembic.ini to your project directory and run the following command

Windows

Use this to set the environment variable in powershell or create new environment variable in your system (this command will only work in powershell and is not persistent)

$env:DISCORD_BOT_TOKEN=your_token

Run it

docker-compose up -d

Linux

export DISCORD_BOT_TOKEN=your_token
sudo docker-compose up -d

🏃 Running locally

Clone the project

git clone https://github.com/Stax124/MoltenCore.git

Go to the project directory

cd MoltenCore

🚩 Bot + Backend + Compiled frontend

Install dependencies

pip install poetry
poetry install

Start up the bot

poe start

Or if you want to help with development

poe dev

🚩 Frontend in development mode

Change directory to frontend

cd frontend

Install dependencies

yarn install

Start the server

vite dev

🧪 Running Tests

To run tests, run the following command

poe test

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

⚠️ License

Distributed under the MIT License. See LICENSE for more information.

🤝 Contact

Tomáš Novák - tamoncz@gmail.com

Project Link: https://github.com/Stax124/MoltenCore

💎 Acknowledgements

• Shields.io