Skip to content

SunriseCommunity/Sunshine

Repository files navigation

🌻 Sunshine - Discord Bot for the Sunrise server

462894956-551fc5b1-2f73-4792-9284-2c2f3452e42b

License GitHub stars

Description

This is a Discord Bot build with Sapphire framework, Bun and TypeScript.

It is a part of the Sunrise project, which aims to create a fully functional osu! private server with all the features that the official server has.

This project also has automated testing setup with GitHub Actions! ✨

Installation (with docker) 🐳

  1. Clone the repository
  2. Create copy of .env.example file as .env and fill all required fields
  3. Update config/prod.json with you own emojis ids (You can find needed files in data/emojis)
  4. Run the following command to create docker container:
docker compose up -d
  1. Bot should be now up and running!

Installation 📩

  1. Clone the repository
  2. Install the required dependencies: bun install
  3. Update config/dev.json with you own emojis ids (You can find needed files in data/emojis)
  4. Create copy of .env.example file as .env and fill all required fields
  5. Start the application with bun run start or bun run dev

Preview 🖼️

New Project (3)

Contributing 💖

If you want to contribute to the project, feel free to fork the repository and submit a pull request. We are open to any suggestions and improvements.

Releases

No releases published

Packages

No packages published