Skip to content

SanukaE/BotBuilder

Repository files navigation

🤖 BotBuilder

Your Free, Open-Source, All-In-One Discord Companion

✨ Features

  • 🎮 Easy file management
  • 🤖 A.I integration
  • 👨‍💻 BuiltIn A.P.I System
  • ⚡ Fast and reliable performance
  • 📘 Helpful Wiki
  • 🔜 Many more to features to come...

⚙ Getting Started

For detailed setup instructions and deployment guides, please refer to our Installation Wiki. The instructions below are primarily for development purposes.

🚀 Prerequisites

Before you begin, ensure you have installed:

  • Node.js (version 18 or higher) 📦
  • pnpm (optional) 🏃‍♂️

🛠️ Installation

  1. Clone the repository:
git clone https://github.com/SanukaE/BotBuilder
cd BotBuilder
  1. Install dependencies:
npm install

or

pnpm install
  1. Create a .env file in the root directory. (see Environment Variables section on the wiki)

  2. Create a config.json file in the root directory. (see Configuration Variables section on the wiki)

🏗️ Building for Production

Create a production build:

npm run build
npm start

or

pnpm build
pnpm start

Your bot will be online and the API endpoints will be available at http://localhost:3000.

Note: The endpoints URL depends on what values you have set in the config.

🤝 Contributing

Contributions are always welcome! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🛠️ Built With

📱 Community Support

Need help or want to join our community? Connect with us on Discord:

Discord

Our Discord server is the best place to:

  • Get real-time support
  • Share your projects
  • Meet other developers
  • Stay updated with latest features

👥 Servers That Use BotBuilder

Check out all these amazing servers that uses BotBuilder's help to manage them.

Be the first server to use BotBuilder.

Note: To add your server to the list please open a ticket on our support server.

📄 License

This project is licensed under the GPL v3.0 License

🙏 Special Thanks To

  • The NamelessMC & MCStatistics team for their support
  • Under Ctrl for providing excellent Discord.js tutorials
  • The Discord AntiScam community for their massive database of scam links
  • All contributors/donators who have helped improve this project

Created with ❤️ by SanukaE