Ani-Notify

A notification system for Anime

Table of Contents

• ⚡General Info
• 🧬Tech Tack
• 🔥Endpoints
• 🔨Setup
• 📝Contribution

⚡General Information

The project is pretty simple, it tracks anime and send notifications to either a discord webhook or a ntfy url.
It can also be integrated into a app to handle notifications.

🧬Tech Stack

• Bun - Js Runtime
• Hono - Api framework
• Prisma - Database ORM
• Consumet.org - Content API

🔥Endpoints

Check the SwaggerUI

🔨Setup

📊Metrics

You can hook Prometheus up to /metrics for metrics.

💻Local Development

1. Clone the repo
2. Install dependencies bun i install
3. Create a .env, and fill it in.
4. Start the server bun run dev

🖥️Docker

Get the .env.example file from the repo, edit it and then rename it to .env

This example expects you use the default database setup from .env.example
Run the image:

docker run -d -it \
--name Ani-Notify \
-p 3000:3000 \
-v ./.env:/usr/src/app/.env \
-v ./db:/usr/src/app/db/ \
ghcr.io/tohjuler/ani-notify:latest

For at full stack deploy (app and consumet api) See docker-compose.yml

Access the api at http://localhost:3000
and the Swagger UI at http://localhost:3000/ui

📝Contribution

Contributions are always welcome! Contributions can be given in the form of:

• Code (PR)
• Documentation (PR)
• Ideas (Issues)
• Bug reports (Issues)