https://github.com/ehiraa/aeri
Display anime, manga or user information, straight from Anilist.
https://github.com/ehiraa/aeri
caching discord discord-bot rust-backend typescript
Last synced: 3 months ago
JSON representation
Display anime, manga or user information, straight from Anilist.
- Host: GitHub
- URL: https://github.com/ehiraa/aeri
- Owner: ehiraa
- License: mit
- Created: 2024-10-19T06:15:31.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-13T18:26:06.000Z (3 months ago)
- Last Synced: 2025-02-13T19:30:22.274Z (3 months ago)
- Topics: caching, discord, discord-bot, rust-backend, typescript
- Language: TypeScript
- Homepage:
- Size: 495 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Aeri
Aeri, a bot that uses the Anilist API to display, captuure and cache data.
> [!IMPORTANT]
> ### COMMANDS
> If you want to use the bot, I'm currently hosting one which you can [invite from this link](https://discord.com/oauth2/authorize?client_id=795916241193140244)
> You can find all of the commands at [aeri's website - Coming Soon](https://devtomos.github.io)
> If you want to use any of the packages, ensure that you follow the Licencse of that package.
> And read the README for anything important
## Features
- [x] Display information from my own Rust API, with automatic caching.
- [x] Setup user accounts to display scores (which also get cached), or unlink
- [x] Wide spread use, can be used across multiple servers and only needs one setup!
- [x] Extremely fast and built in logging
## Using Aeri
1. Use the `.env.example` to create an `.env` file (Ensure the `.env` is within the root of the project)
2. Once setup the `.env` file, ensure you have both Docker, Docker Compose and NodeJS installed for your system
3. Install pnpm `npm install -g pnpm`
4. Run `pnpm all` and allow it to create and launch everything, seamlessly.
## Contributing to Aeri
If you feel like Aeri is missing certain features, or would like to see more stuff implemented
Feel free to open a pull requests or issue.
1. Fork the repository
2. Create a new branch: `git checkout -b ''`
3. Make your changes and commit them: `git commit -m ''`
4. Push to the original branch: `git push origin '/'`
5. Create the pull request
## License
This project uses the following license: [MIT LICENSE](https://github.com/devtomos/aeri/blob/main/LICENSE.md).