Skip to content

My Local Development Environment

Basic setup to get started with the examples in this project.

WSL, VS Code, and Git

  1. Installation - https://learn.microsoft.com/en-us/windows/wsl/install

  2. Best practices for setup - https://learn.microsoft.com/en-us/windows/wsl/setup/environment

  3. Get started with VS Code - https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-vscode

  4. Get started with Git - https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-git

GitHub and Git

  1. Setting your username in Git - https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git

  2. Setting your commit email address - https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address

  3. Generating a new SSH key and adding it to the ssh-agent - https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

  4. Testing your SSH connection - https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection

Homebrew

The Missing Package Manager for macOS (or Linux) 1

Installation

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

nvm

nvm allows you to quickly install and use different versions of node via the command line. 2

nvm installation with Homebrew

brew install nvm

Node.js

Node.js is an open-source, cross-platform JavaScript runtime environment. 3

pyenv

pyenv lets you easily switch between multiple versions of Python. It's simple, unobtrusive, and follows the UNIX tradition of single-purpose tools that do one thing well. 4

pyenv installation with Homebrew

brew install pyenv

Python

Python is a programming language that lets you work quickly and integrate systems more effectively. 5

MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. 6

Getting started with MkDocs

  1. Requirements - https://www.mkdocs.org/user-guide/installation/#requirements
  2. Installing MkDocs - https://www.mkdocs.org/user-guide/installation/#installing-mkdocs
  3. Themes (material) - https://github.com/squidfunk/mkdocs-material#quick-start
  4. Formatting options (markdown_extensions) - https://www.mkdocs.org/user-guide/configuration/#formatting-options
  5. Run the builtin development server - https://www.mkdocs.org/user-guide/cli/#mkdocs-serve
  6. Deployment options - https://www.mkdocs.org/user-guide/deploying-your-docs/

  1. brew.sh ↩

  2. https://github.com/nvm-sh ↩

  3. https://nodejs.org/en ↩

  4. https://github.com/pyenv ↩

  5. https://www.python.org/ ↩

  6. https://www.mkdocs.org/ ↩