CONTRIBUTING.md

Contributing to the compiler

Instructions for contributing a recipe can be found here.

How to clone and set up the repository

Please make a fork of the repository if you would like to make a contribution.

Clone your fork with git clone

git clone https://github.com/<YOUR-GITHUB-USERNAME>/DevCookbook

Linux

Change directory into the project:

cd DevCookbook

Create a virtual environment for installing packages:

python3.9 -m venv .venv

Activate the virtual environment:

source .venv/bin/activate

Install the required dependencies:

pip install -r requirements.txt

Windows

Change directory into the project:

cd DevCookbook

Create a virtual environment for installing packages:

python3.9 -m venv .venv

Activate the virtual environment:

.venv\Scripts\Activate.ps1

Note, you may run into this error

.\.venv\Scripts\Activate.ps1 : File C:\Users\<username>\devcookbook\.venv\Scripts\Activate.ps1 cannot be loaded because running scripts is disabled on this system.
For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170.

To solve this problem run the following script in an elevated terminal:

Set-ExecutionPolicy RemoteSigned

More information on PowerShell execution policies

Install the required dependencies:

pip install -r requirements.txt

Compile and run the site locally

python compile.py

If you are building this for Github Pages, use the --prod flag to correctly link CSS in the rendered output

python compile.py --prod

This will output the HTML and CSS that make up the static site in the docs directory.

You can serve this HTML using

python -m http.server --directory docs