Clone Starter Project
We will guide you through the process of cloning the boilerplate project to your development machine. The boilerplate project has everything you need to get started to include several dummy functions that you can you use.
Step 1: Clone the project
Clone using Git SSH
Clone using Git HTTPS
Step 2: Setup Python Virtual Environment
To isolate your project's dependencies and ensure a clean and reproducible development environment, it's recommended to use a Python virtual environment. Follow the steps below to set up the virtual environment for the cloned boilerplate project.
2.1 Create the Virtual Environment
Create a virtual environment named venv (or any name you prefer):
2.2 Activate the Virtual Environment
After creating the virtual environment, you need to activate it. The method of activation varies depending on your operating system:
On macOS/Linux:
On Windows:
Once activated, your command prompt should change to indicate that you're now working within the virtual environment.
2.3 Install Dependencies
With the virtual environment activated, install the required dependencies for your project by running:
This command reads the requirements.txt file, which lists all the necessary Python packages, and installs them into your virtual environment.
Now your development environment is set up, and you're ready to start working on your project.