applejuicelolmc/shrimp-bot repository overview

• About Shrimp⁠
• Features⁠
  • Commands⁠
• Setup⁠
  • Bot configuration (soon™)⁠
• Deploying the bot⁠
  • Requirements⁠
  • Deployment methods⁠
    • Starting your bot with portainer⁠
    • Starting your bot with docker compose⁠
    • Running your bot with pnpm⁠

⁠1️⃣ Starting your bot with portainer

1. Make sure you have a working portainer setup
2. Copy the example.env to the computer you use to access portainer and rename it to main.env
3. Edit your new main.env file and add the neccesary tokens/id's described in it
4. In portainer: add a new container from dockerhub with this specific image: applejuicelolmc/shrimp-bot:latest
5. Go the advanced container settings and there: click on the env tab, there you can upload the main.env file
6. That's it now you should be able to deploy the container if all env variables are correct

⁠2️⃣ Starting your bot locally with docker compose

1. Make sure the latest version of docker is installed
2. Clone this repository to your computer/server
3. rename the example.env file you can find in the root of this project to main.env
4. Edit your new main.env file and add the neccesary tokens/id's described in it
5. Start the bot by running sudo docker compose up -d

⁠3️⃣ Running your bot with pnpm

1. Clone this repository to your computer/server
2. In your terminal, navigate to the folder where you stored this repository and run pnpm install
3. rename the example.env file you can find in the root of this project to main.env
4. Edit your new main.env file and add the neccesary tokens/id's described in it
5. Start your bot by running pnpm start
6. Removed some existing commands? Run pnpm run reset to reset the existing commands on all servers before adding the new commands (Gonna automate this sometime)