Jasper

🔍 🔨 The multipurpose Discord bot for No Text To Speech!

• 💾 Database - Dockerized Databases Enviroment for the Jasper Bot
• 🤖 Bot - The main Discord bot (Node.js)
• 🌐 Webserver - Spring Boot server providing web functionality
• 🚀 WebserverGo - Go-based webserver (remake of the Java SpringBoot webserver)

Project Structure

.
├── apps/
│   ├── bot/         # Discord bot application
|   ├── databases/   # MongoDB and Redis Docker Containers
│   ├── webserver/   # Spring Boot server
│   ├── webserverGo/ # Go-based webserver (remake of the Java SpringBoot webserver)
├── compose.yml      # Docker Compose configuration
└── .env             # Environment variables

Getting Started

1. Clone the repository
2. Copy .env.example to .env and fill in required values
3. Choose your preferred setup method:

Local Development

Each application can be run locally:

Bot

cd apps/bot
yarn install
yarn dev

Databases

Follow the setup instructions in apps/databases/README.md to configure and start MongoDB and Redis services.

Webserver

cd apps/webserver
./gradlew bootRun

WebserverGo

cd apps/webserverGo
make build
make run

For more details, see the WebserverGo Documentation.

Using Docker

The entire ecosystem can be run using Docker Compose:

# Build all containers
docker-compose build

# Start all services
docker-compose up -d

# View logs
docker-compose logs -f

# Stop all services
docker-compose down

Individual services can be managed with:

# Start/stop specific service
docker-compose up -d [bot|webserver]
docker-compose stop [bot|webserver]

Environment Variables

See the individual README files in each application directory for details on required environment variables:

• Bot Environment Variables
• Databases Instances Variables
• Webserver Environment Variables
• WebserverGo Environment Variables

Documentation

Each application has its own README with detailed documentation:

• Bot Documentation
• Databases Instances Documentation
• Webserver Documentation
• WebserverGo Documentation

Contributing

See CONTRIBUTING.md for details on how to contribute to this project.

License

This project is licensed under the MIT License - see LICENSE for details.