GroovyGab / Zora

Ayo the pizza here

Zora

Do not take this README into consideration this thing is almost completely wrong, i'll update it sometime 😗

ℹ️ About Zora

Nothing for now :P

🛠️ How to Self-Host the Bot

To self-host the bot you need the following requirements:

• Discord Bot Token.

• A Redis Instance.
  Option 1: Using Redislabs
  Option 2: Host it Yourself

• A MongoDB Database.
  Option 1: Using MongoDB Atlas
  Option 2: Host it Yourself

• Node.js v13 or higher.

Instructions:

1. Clone the repository: git clone https://github.com/GaboTheCoder/Zora (You can also download it from here)

2. Run npm install

3. Rename config.json.example to config.json and add your data (Bot Token, Database endpoints, etc)

4. Run npm start

5. Invite the bot application to your server.

📋 To do List / Ideas

• Lots of commands.
• Docker.
• A Deploy to Heroku button.
• Moderator log.
• Moderation commands.
• Fun commands.
• Utility commands.
• Per-Server translation.

Work in Progress

• Commands
• i18n Translation.

❌ Canceled

• RESTful API, Reason: I think it was a overcomplicated piece of code and is not really that necessary, Maybe in the future i will continue the development of the api but for other things.

💡 Feature requests

How to request a feature:

• Open a new issue here

• Pick the Feature Request option.

• Leave all your ideas and things that you think would be useful / nice for the bot.

• Submit the issue.

🐛 Bug reports

How to report a bug:

• Open a new issue here

• Pick the Bug Report Option.

• Describe the problem with the most details you can.

• Submit the issue.

📝 Contributing

• As a Open Source project we would love your contributions.

How to Contribute.

• Fork the repository

• Clone your fork: git clone https://github.com/your-username/Zora

• Create a branch for your new feature: git checkout -b awesome-new-feature

• Commit your changes: git commit -am 'My Awesome Feature'

• Push to your feature branch: git push awesome-new-feature

• Submit a pull request.

⚖️ License

• This project is Licensed under the Apache-2.0 License, click here to learn more.

🤝 Acknowledgments

• The discord.js team For their amazing job creating the discord.js Library.

• MenuDocs For the Event Handler used in this Bot.

• And to you for checking out this project :D