/aziris

🔘 Bot to help a manage you server

Primary LanguageTypeScriptMIT LicenseMIT

Gitpod

License Last Commit Language Most Used Implementations Repository Size

Forks Stars Watches

Author Twitter

Welcome to aziris 👋

🚧 aziris in development... 🚧

logo

Simple bot to help a manage you server

🏡 Home: https://mikael-r.github.io/aziris/

🔖 Table Of Contents

🤔 How To Use

💻 Desktop

Obs: To run in you machine you need node, git and npm/yarn

  • Clone repository and entry on dir
git clone https://github.com/Mikael-R/aziris
cd aziris

Using Node.js

  • Create a bot in discord developers
  • Generate bot token and copy token in .env file, check file env with example
  • Generate convite link to add bot in servers

Obs: Search in discord developers oficial documentation for more informations.

  • Install dependencies
yarn  # or npm install
Dev Mode
yarn dev # or npm run dev
Production Mode
yarn prod  # or npm run prod

Using Docker (with docker-compose)

Dev Mode
docker-compose up # (optional -d to run in background)
Production Mode
docker-compose up -f docker-compose.prod.yml # (optional -d to run in background)

🌐 Online

  • Add bot clicking here
  • Select server and authorize bot to entry
  • Call using $help

Back To The Top

🚀 Technologies

  • Discord.js
  • Node
  • Typescript

Back To The Top

🌱 Minimal Requirements

  • Node
  • NPM/Yarn
  • Git

Back To The Top

🎊 Features

🎆 Pendent

  • create CRUD
  • craete commands for ban, warn, mute, etc
  • create experiencie system
  • craete commands for xp system

Back To The Top

💡 How To Contribute

  • Make a fork of this repository
  • Clone to you machine and entry on respective paste
  • Create a branch with your resource: git checkout -b my-feature
  • Commit your changes: git commit -m 'feat: My new feature'
  • Push your branch: git push origin my-feature
  • A green button will appear at the beginning of this repository
  • Click to open and fill in the pull request information

Contributions, issues and features requests are welcome!
📮 Submit PRs to help solve issues or add features
🐛 Find and report issues
🌟 Star the project

Back To The Top

🤗 Contributors

Mikael-R

Back To The Top

👤 Author

🤓 Mikael Rolim de Aquino mikarg9@gmail.com

Back To The Top

🔏 License

Copyright © 2020 Mikael Rolim de Aquino mikarg9@gmail.com

This project is licensed by MIT License.

Back To The Top

This README was generated with 💟 by readme-template-generator