Skip to content

Latest commit

 

History

History
46 lines (41 loc) · 3.5 KB

SETUP.md

File metadata and controls

46 lines (41 loc) · 3.5 KB
Raw

Setup from Scratch

This document details the setup process of downloading a development copy of Tablebot. This was originally authored by Benji (Git won't reflect this as it was taken out of CONTRIBUTING.md).

If at any point something doesn't work, restart your computer first and try it again. If the problem persists please feel free to ask for help in the Discord server. Sections are marked depending on what OS they rely on, if any.

  1. git, wsl, and vscode setup
    1. github
      1. Create a GitHub account
      2. Go to https://github.com/WarwickTabletop/tablebot
      3. Click fork on the repo (should be top right) (this creates your own version of the repo)
      4. Take note of the url that your forked repo is on
    2. wsl and git (Windows)
      1. Install wsl by going to https://docs.microsoft.com/en-us/windows/wsl/install, and make sure it's in the right click context menu of folders
      2. Navigate to an empty folder on your computer that you want to do your programming from (the project folder)
      3. Shift-right click in the project folder, and click "open linux shell here"
      4. Type git clone <your repo url> into the terminal
      5. The folder should be filled with a bunch of files and folders
    3. terminal and git (Linux)
      1. Navigate to an empty folder on your computer that you want to do your programming from (the project folder)
      2. Shift-right click in the project folder and press "open in terminal"
      3. Type git clone <your repo url> into the terminal
      4. The folder should be filled with a bunch of files and folders
    4. vscode
      1. Install vscode from https://code.visualstudio.com/
      2. Install this https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack
      3. From a terminal opened in the project folder, type code .
      4. There should soon be a window which has all the folders and files open on the left hand side
  2. Haskell setup
    1. In any linux terminal window (wsl or the linux terminal itself), type curl -sSL https://get.haskellstack.org/ | sh, allowing sudo access and providing passwords as needed
    2. In the linux terminal window opened from the project folder (or the terminal open in the vscode window) run stack build, and then wait until it's done
    3. This will take a long time
    4. Make some tea, or maybe some coffee or hot chocolate
    5. If it didn't work, reopen all terminal windows and try again. if that doesn't work, restart your computer and try again
    6. Install this https://marketplace.visualstudio.com/items?itemName=haskell.haskell
    7. Open a file and marvel at the colours, and the fact you can hover over things and see values and stuff
  3. Discord and Environment variables
    1. Create a file in the top level of the project folder called .env, based on the template in .env.example
    2. Follow the instructions in Environment File Setup to fill in the .env. Make sure to get a DISCORD_TOKEN and a SQLITE_FILENAME (which can be named anything, but use something like database.db)
    3. To run the bot, type stack run into the terminal, and the bot will start to run
    4. Make sure to invite the bot to a server so you can test it out!

Congratulations, you now know the very basics needed to set up your own tablebot!

To learn more about git, you should look up a tutorial or watch this video: https://youtu.be/HOIC804Berc