Creating a Dev Environment

Prerequisites

VSCode Extensions

• Python (because python)
• Django (django template syntax highlighting)
• GitLens (very good extension in general, everyone should have it)

Tools

• Visual Studio Code (recommended code editor, but if you are truly insane you can use vim lmao)
• pipenv (virtual environments)
• git (version control)
• GitHub CLI (github authorization)

Things to do before setting up

• Make sure you are logged in to GitHub via GitHub CLI. To do this, run gh auth login in a terminal and follow the steps.

Tips

• You can open a PowerShell terminal in a directory by pressing shift+right-click and selecting "Open in Powershell terminal" in the right click prompt. This option is not shown when right clicking normally.
• In VSCode, to open an integrated terminal you can press ctrl+shift+`.

Setting up a Dev Environment

Step 1: Clone the repo

• Open up a terminal then navigate to your preferred directory
• Run git clone https://github.com/worcestertechnicalhighschool/ratatoskr.git
• Run cd ./ratatoskr
• Run code . to open VSCode in the current directory

Step 2: Setup a virtual environment

• In a terminal, run pipenv install
• That's it I guess...

Other steps to make your life easier

Recommended VSCode configurations

I would really recommend disabling the Django extension by default mostly due to it hijacking control over all .html files. You can enable it only for one workspace by clicking the dropdown arrow beside "Enable" and clicking "Enable (workspace).

Also, if you navigate to your settings.json (ctrl+,, then click on the paper icon on the top right), you can add the following snippet to re-enable Emmet while editing Django templates

    "emmet.includeLanguages": {
        "django-html": "html"
    },