alex/discord-ollama
1
0
Fork 0
mirror of https://github.com/kevinthedang/discord-ollama.git synced 2025-12-12 11:56:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

formatting and contributing

Browse Source 
* fixed some formatting

* contributing format

* simple style rules
This commit is contained in:
Kevin Dang
2024-01-30 16:15:35 -08:00
committed by GitHub
parent 9247463480
commit b94ff55449
8 changed files with 56 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,38 @@
<!--
Author: Kevin Dang
Date: 1-30-2024
-->
## 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](https://discord.com/developers/) 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](https://www.youtube.com/watch?v=KZ3tIGHU314&ab_channel=UnderCtrl).
* Now run `npm run start` to run the client and ollama at the same time (this must be one in wsl or a Linux distro)
## Set up (Development-side)
* Pull the repository using `https://github.com/kevinthedang/discord-ollama.git`.
* Refer to `Ollama 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` and `To Run` in the readme for a bit of help.
* You can also reference [NodeJS Setup](#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 two environment files:
* `.env`: for running the bot
* `CLIENT_TOKEN`: the token for the bot to log in
* `CHANNEL_ID`: the id of the channel you wish for the bot to listen in
* `MODEL`: the mode you wish to use
* `BOT_UID`: the user id the bot goes by (the id of the discord user)
* `.env.dev.local`: also runs the bot, but with development variables
* Currently there are no differences between the two, but when needed, you may add environment variables as needed.
## NodeJS Setup
* Install [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) 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.

5
.github/style.md vendored Normal file
View File

@@ -0,0 +1,5 @@
## Style Preferences
* Please just make sure that you are using a `Tab Default` of 4 for spacing
* You don't need semicolons at the end of everything.
* Comments for functions would be nice to help explain what they do and what the parameters are for.
* If there are any other issues, just refer to the [Google Style Guide](https://google.github.io/styleguide/tsguide.html)