Developer Cheatsheet and Tips

This section covers various commands and tips that may make development easier. Feel free to update with what you find helpful!

Cheatsheet

Pipenv usage

To activate the backend python environment in the terminal, run source apps/backend/.venv/Scripts/activate

To activate the documentation python environment in the terminal, run source docs/.venv/Scripts/activate

To disable, run deactivate

Tips

Aliases

You can use command aliases to avoid remembering long, but commonly used terminal commands, or even multiple commands. I (Alan) personally found making aliases for git commands to be useful for general development, even outside of this project. There are many guides online showing how to set up aliases on various terminal environments, it may differ depending on what terminal you use.