https://github.com/mikael-r/aziris
🔘 Bot to help a manage you server
https://github.com/mikael-r/aziris
bot bot-manager discord discord-bots discord-developers discordjs hacktoberfest typescript
Last synced: 2 months ago
JSON representation
🔘 Bot to help a manage you server
- Host: GitHub
- URL: https://github.com/mikael-r/aziris
- Owner: Mikael-R
- License: mit
- Created: 2020-07-06T21:11:31.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-29T11:28:06.000Z (over 4 years ago)
- Last Synced: 2024-12-31T05:41:48.720Z (4 months ago)
- Topics: bot, bot-manager, discord, discord-bots, discord-developers, discordjs, hacktoberfest, typescript
- Language: TypeScript
- Homepage: https://mikael-r.github.io/aziris/
- Size: 160 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://gitpod.io/#https://github.com/Mikael-R/aziris)
[](LICENSE.md) [](https://github.com/Mikael-R/aziris/commits/)  [](https://github.com/Mikael-R/aziris/issues) 
[](https://github.com/Mikael-R/aziris/network/members) [](https://github.com/Mikael-R/aziris/stargazers) [](https://github.com/Mikael-R/aziris/watchers)
[](https://twitter.com/mikaelr16)
Welcome to aziris 👋
🚧 aziris in development... 🚧
> Simple bot to help a manage you server
🏡 Home: https://mikael-r.github.io/aziris/
### 🔖 Table Of Contents
- 🤔 [How To Use](#how-to-use)
- 🚀 [Technologies](#technologies)
- 🌱 [Minimal Requirements](#minimal-requirements)
- 🎊 [Features](#features)
- 🎇 [Finished](#features-finished)
- 🎆 [Pendent](#features-pendent)
- 💡 [How To Contribute](#how-to-contribute)
- 🤗 [Contributors](#contributors)
- 👤 [Author](#author)
- 🔏 [License](#license)
---
🤔 How To Use
#### 💻 Desktop
Obs: To run in you machine you need node, git and npm/yarn
- Clone repository and entry on dir
```sh
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](.env.example)
- Generate convite link to add bot in servers
Obs: Search in discord developers [oficial documentation](https://discord.com/developers/docs/intro) for more informations.
- Install dependencies
```sh
yarn # or npm install
```
##### Dev Mode
```sh
yarn dev # or npm run dev
```
##### Production Mode
```sh
yarn prod # or npm run prod
```
#### Using Docker (with docker-compose)
##### Dev Mode
```sh
docker-compose up # (optional -d to run in background)
```
##### Production Mode
```sh
docker-compose up -f docker-compose.prod.yml # (optional -d to run in background)
```
#### 🌐 Online
- Add bot clicking [here](https://discord.com/oauth2/authorize?client_id=736626386009194676&scope=bot&permissions=2146958847)
- Select server and authorize bot to entry
- Call using `$help`
[Back To The Top](#title)
---
🚀 Technologies
- Discord.js
- Node
- Typescript
[Back To The Top](#title)
---
🌱 Minimal Requirements
- Node
- NPM/Yarn
- Git
[Back To The Top](#title)
---
🎊 Features
🎆 Pendent
- [ ] create CRUD
- [ ] craete commands for ban, warn, mute, etc
- [ ] create experiencie system
- [ ] craete commands for xp system
[Back To The Top](#title)
---
💡 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](#title)
---
🤗 Contributors
[Back To The Top](#title)
---
👤 Author
🤓 **Mikael Rolim de Aquino **
- Twitter: [@mikaelr16](https://twitter.com/mikaelr16)
- Github: [@Mikael-R](https://github.com/Mikael-R)
[Back To The Top](#title)
---
🔏 License
Copyright © 2020 [Mikael Rolim de Aquino ](https://github.com/Mikael-R)
This project is licensed by [MIT License](https://api.github.com/licenses/mit).
[Back To The Top](#title)
---
_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_