Skip to main content
Cytric.png

How to Set Up the Template Bot on Cytric Using GitHub

Step-by-Step Instructions

1. Log into the Cytric Panel and Head over to the Startup page

2. Clone the GitHub Repository

  • GIT REPO ADDRESS:
    • Enter the GitHub repository link.
    • Repo Link: https://github.com/Cytric/Discord-JS-MongoDB-Template
    • Description: This is the GitHub repository to clone.
git-Image

3. Select the Install Branch

  • INSTALL BRANCH:
    • Enter main.
    • Description: The branch of the bot to install.
branch-Image

4. User Uploaded Files

  • USER UPLOADED FILES:
    • Disable to skip all the install stuff.
    • Description: Skip all the install stuff if you are letting a user upload files. 0 = false (default), 1 = true.
files-Image

5. Auto Update

  • AUTO UPDATE:
    • Enable or disable based on your preference.
    • Description: Pull the latest files on startup when using a GitHub repo. Note: After manually changing the code in the panel - updates made on the original repository will be blocked.
update-Image

6. Specify the Bot Entry Point

  • BOT JS FILE:
    • Enter src/index.js.
    • Description: The file that starts the bot.
src-Image

7. Install Additional Node Packages

  • ADDITIONAL NODE PACKAGES:
    • Enter discord.js axios discord-logs mongodb [email protected] dotenv canvas @napi-rs/canvas os discord-gamecord dotenv.
    • Description: Install additional node packages. Use spaces to separate.
packages-Image

8. GitHub Authentication

  • GIT USERNAME: - Enter Cytric as the GitHub username. - Description: Username to authenticate with Git.
username-Image
  • GIT ACCESS TOKEN (Not needed):
    • Enter your GitHub Personal Access Token if you are using it out of a own private repository.
    • Description: Password to use with Git but with a private repository. It’s best practice to use a Personal Access Token. Create a GitHub Personal Access Token.
GITaccess-Image

9. Uninstall Node Packages

  • UNINSTALL NODE PACKAGES:
    • Leave this field empty or enter the packages you want to uninstall.
    • Description: Uninstall node packages. Use spaces to separate.
uninstall-Image

MongoDB Setup Instructions

Step 1: Follow our Cytric MongoDB Guide

  • Go to MongoDB Guide and follow the prompts to set up a new cluster.

Step 2: Update Your .env file

  • Edit your Discord Bot Token and MongoDB URL in the .env file:
    token=your_discord_bot_token
    MONGODBURI=your_mongodb_connection_string
    

Need support for setting up your bot?

[email protected]