HiFi-API

Table of Contents

• HiFi-API
  • Table of Contents
  • Prerequisites
  • Installation

Prerequisites

Before you begin, ensure you have the following installed:

• Python: Version specified in .python-version (e.g., Python 3.9+). Check your version with python --version
• uv: A fast Python package installer and resolver

  pip install uv
  # Or, for global installation:
  # pipx install uv

Installation

Follow these steps to set up the HIFI-API project locally:

1. Clone the repository:

   git clone <your-repository-url>
   cd hifi-api

2. Set up Environment Variables: Create a .env file in the root directory by copying the example file:

   cp .env.example .env

   Open the newly created .env file and fill in the necessary environment variables, especially your Firebase credentials and any other API keys.

3. Install Dependencies: Use uv to synchronize and install the project dependencies. This will also create a virtual environment (.venv) if it doesn't exist:

   uv sync

4. Run The Serivce: Use uvicorn to run the fastapi server

   uvicorn app.main:app --reload