---
title: Keepme Backend
emoji: 🏃
colorFrom: green
colorTo: blue
sdk: docker
pinned: false
---

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

# KeepMe

## Prerequisites

- Python 3.11.*
- Poetry
- OpenAI API Key
- Pinecone
- MongoDB
- Redis

## Installation

1. Set up a virtual environment using Poetry

```bash
poetry install
```

2. Create a `.env` file in the root directory and add the environment variables mentioned in the `.env.example` file.

```bash
cp .env.example .env
```

3. Start the FastAPI server

```bash
poetry run uvicorn src.app:app --reload
```

## Docker Installation

1. Build the Docker image

```bash
docker build -t keepme-backend .
```

2. Run the Docker container

```bash
docker run -d -p 7860:7860 --env-file .env keepme-backend
```

## API Documentation

After starting the FastAPI server, you can access the API documentation at `http://localhost:8000/docs`.