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
- ๐ Technologies
- ๐ฑ Minimal Requirements
- ๐ Features
- ๐ก How To Contribute
- ๐ค Contributors
- ๐ค Author
- ๐ License
๐ค 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
๐ Technologies
- Discord.js
- Node
- Typescript
๐ฑ Minimal Requirements
- Node
- NPM/Yarn
- Git
๐ Features
<h4 id=โfeatures-finished>๐ Finished</h4>
- create initial commands
- create ambient config
<h4 id=โfeatures-pendent>๐ Pendent</h4>
- create CRUD
- craete commands for ban, warn, mute, etc
- create experiencie system
- craete commands for xp system
๐ก 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
๐ค Contributors
๐ค Author
๐ค Mikael Rolim de Aquino mikarg9@gmail.com
- Twitter: @mikaelr16
- Github: @Mikael-R
๐ License
Copyright ยฉ 2020 Mikael Rolim de Aquino mikarg9@gmail.com
This project is licensed by MIT License.
This README was generated with ๐ by readme-template-generator