Skip to content
This repository was archived by the owner on Apr 29, 2025. It is now read-only.

01-prerequisites.md

Latest commit

 

History

History
105 lines (71 loc) · 3.33 KB

01-prerequisites.md

File metadata and controls

105 lines (71 loc) · 3.33 KB

Prerequisites

Environment Setup

.env File

The project uses environment variables to manage configuration settings. Ensure you have a .env file in your project directory. You can create this file by copying and adapting the provided .env.docker.example file:

cp .env.docker.example .env.docker

Project Setup Guide

After copying and adapting the file, open it and add your desired values for configuration.

Docker

To run the project within Docker, you need to have Docker installed on your system. Follow the instructions below to set up Docker:

  1. Install Docker:

  2. Verify Docker Installation:

    • Open a terminal and run the following command to verify Docker is installed correctly:

      docker --version

    • This should print the Docker version installed on your machine.

Local Development

If you prefer to run the project without Docker, ensure you have Python and Pipenv installed on your system. Follow these steps for the setup:

  1. Install Python:

  2. Install Pipenv:

    • Pipenv is used for creating virtual environments and managing packages. Install Pipenv by running: 
      pip install pipenv

  3. Install Project Dependencies:

    • Navigate to your project directory and install the required packages using Pipenv: 
      pipenv install
    • If you are using pytest and mypy, install the development dependencies: 
      pipenv install --dev

  4. Activate Virtual Environment:

    • Enter the virtual environment shell: 
      pipenv shell
    • If you prefer not to enter the shell, you can run commands directly using: 
      pipenv run <command>

Ollama

The project relies on the Ollama API for generating AI-powered recommendations. Follow these steps to set up Ollama when running without Docker:

  1. Install Ollama:

  2. Configure Ollama URL:

    • Ensure the correct URL for the Ollama API is set in your .env file: 
      OLLAMA_URL=http://localhost:11434

  3. Download Ollama Models:

    • Download the required Ollama models by running the following command: 
      ollama pull <model-name>
    • Replace <model-name> with the name of the model you want to download. You can find available models on OLLAMA's Library page.

Summary | TLDR

Depending on your preference, you can choose to run the project using Docker or locally.

Docker

  • Prerequisites: Docker installed on your system.
  • Setup: Copy and adapt the .env.docker.example file.
  • Installation: Follow the Docker Installation guide for further setup.

Local Development

  • Prerequisites: Python and Pipenv installed on your system.
  • Environment Setup: Copy and adapt the .env.docker.example file.
  • Installation: Follow the Local Development Installation guide for further setup.