Prerequisites

Development Environment

Install Git & Git LFS
Install Node
- Consider using nvm instead:
  - Mac
  - Windows
Install pnpm
- Use the following command to install pnpm via npx:
  - npx pnpm add -g pnpm
Install yeoman
- pnpm add -g yo
Install our Genesis CLI tool
- pnpm add -g @mvps-genesis/cli
Configure your linters

If you're going to be contributing to Genesis & writing documentation:

Install Python & Pip
- Install Python
- Install pip
Setup
- Run the init:python pnpm script at the root of the monorepo to create the python virtual environment.
Activation
- Run the following command in your terminal to start your virtual environment

Platform	Shell	Command to activate virtual environment
POSIX	bash/zsh	`$ source pyenv/bin/activate`
	fish	`$ source pyenv/bin/activate.fish`
	csh/tcsh	`$ source pyenv/bin/activate.csh`
	PowerShell Core	`$ pyenv/bin/Activate.ps1`
Windows	cmd.exe	`C:\> pyenv\Scripts\activate.bat`
	PowerShell	`PS C:\> pyenv\Scripts\Activate.ps1`
	bash	`$ source pyenv/Scripts/activate`

Note

You can have your venv automatically be applied to new terminal windows in VSCode by setting your python interpreter.

See https://code.visualstudio.com/docs/python/environments for instructions.

Installing Packages
- Once you have activated your virtual environment run:
- $ pip install -r requirements.txt
Start or Build Documentation
- $ pnpm run start:docs - Start mkdocs in "watch" mode.
- $ pnpm run build:docs - Build mkdocs for production.

Note

Read more about python -m venv here: https://docs.python.org/3/tutorial/venv.html