Skip to content

JayyDoesDev/jasper

Repository files navigation

jasper

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:

Documentation

Each application has its own README with detailed 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.

About

πŸ”πŸ”¨ A multipurpose Discord bot for the No Text To Speech Discord!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8