https://github.com/uhuh/vivi

https://github.com/uhuh/vivi

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/uhuh/vivi
• Owner: Uhuh
• Created: 2020-07-13T19:16:16.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-09T04:07:50.000Z (almost 3 years ago)
• Last Synced: 2024-10-25T17:34:02.881Z (2 months ago)
• Language: TypeScript
• Size: 3.5 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome

Welcome to the ViviBot team. This README is for the TypeScript version of the bot.  

If you see this and are *_not_* using TypeScript you're in the wrong spot.

This guide was written by [Dylan Warren (Panku#0721)](https://github.com/uhuh).

# Environment setup

It is ***extremely ideal that you do this in a linux environment***. This bot works just fine in Windows Subsystem for Linux (WSL). If you don't have this installed follow [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10).

* Personally I use `yarn` over `npm`. There used to be great benefits to using `yarn` but as far as I know these days they aren't too different. However to follow good practices that companies use let's use `yarn` and a node version manager called `nvm`.

Install `yarn` by running these commands

> `curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -`  

> `echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list`

After the above finishes install by doing:

> `sudo apt update && sudo apt install --no-install-recommends yarn`

Verify that it installed correctly with `yarn -v`

After installing `yarn` make sure you install `node`. We want to make sure we're all using the same version of `node` so it is easiest to install a thing called `nvm`.

> `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash`  

> `export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")" [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm`

Verify that `nvm` installed correctly with `nvm --version`

Node `13.14` is a nice version currently that is supported my almost all npm packages. so do  

> `nvm install 13 && nvm alias default 13`

Finally for the SQLite database that is used you need to install

> `sudo apt install build-essential`

# Running the bot

Now that your environment is primed and ready to run the bot we just have a few more things. :)

Instead of a `.json` file to store secrets we're gonna use the beloved `.env` file.  

Create a `.env` file and put this in it.

```

TOKEN=BotTokenHere

PREFIX=PrefixGoesHere

```

Be in the bots directory `Bow-Bot/` and run `yarn` to install all the packages.

Finally to run the bot just do `yarn start` and enjoy! :)