ClarifAI

High-Tech Entrepreneurship

Adrien JAYAT, Lou-Anne HARRAU, Yani HUART, Vassily BERARD, Enzo DONATI, Marta LLULL

 

Overview

ClarifAI is a web application that allows users to learn with the help of AI. It provides a platform where users can uplaod videos, and ask questions to a Chatbot, use tools like text transcription and summarization.

Environment

To run the application, you need to set up the environment variables. Create a .env file in the root directory of the project and add the following variables:

OPENAI_API_KEY=<your_openai_api_key>

Easy Setup with Docker

Docker can be used to run the backend, the frontend, and the database in isolated containers. You need to install Docker on your system.

Then start the Docker containers with the following command:

docker compose up

Dependencies

Backend

The API is built using FastAPI, you need to install Python 3.11 or more.

Using uv

Install uv with pip install uv.

Then, make sure you are in the backend/ directory and run the following command to install dependencies:

uv sync

Frontend

Install Node.js and npm (comes with Node.js).

You can start the frontend with the following command:

npm run start