discord-aidolls/.github/CONTRIBUTING.md

Naming Conventions

• Branches
  • prefix your branch name with the type of contribution:
    • features: 'feature/**'
    • releases: 'releases/**'
    • bugs: 'bug/**'

Run the Bot

• Refer to all sections below before running the bot.
• You should now have Ollama, NodeJS, ran npm install.
• You will also need a discord bot to run. Refer to the developer portal to learn how to set one up and invite it to your server. If that does not help then look up a YouTube video like this one.
• Now run npm run client to run the client (this must be done in wsl or a Linux distro)

Set up (Development-side)

• Pull the repository using https://github.com/kevinthedang/discord-ollama.git.
• Refer to Environment Setup in the readme to set up Ollama.
  • This must be set up in a Linux environment or wsl2.
• Install NodeJS v18.18.2
  • You can check out Resources in the readme for a bit of help.
  • You can also reference NodeJS Setup
• When you have the project pulled from github, open up a terminal and run npm i or npm install to get all of the packages for the project.
• In some kind of terminal (git bash is good) to run the client. You can run Ollama but opening up wsl2 and typing ollama serve.
  • Refer to Ollama Setup if there are any issues.

Environment

• You will need an environment file:
  • .env: for running the bot
    • Please refer to .env.sample for all environment variables to include

NodeJS Setup

• Install nvm using curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
  • Ensure this in the profile of what shell you use (for git bash it would be .bash_profile found in your home directory)
• Ensure it has been install correctly by running nvm -v
• Now, install v18.18.2 by running nvm install 18.18.2
• Then run nvm use 18.18.2 | nvm alias default 18.18.2 or you can run them separately if that does not work. This just sets the default NodeJS to v18.18.2 when launching a shell.