/projet-Quokka

Primary LanguageJupyter Notebook

Projet Quokka

Repository for the Quokka project.

https://github.com/vsantele/projet-Quokka

Server

The server is made with FastAPI.

Installation

Requirements

Setup

  • Clone the project
git clone https://github.com/vsantele/projet-Quokka
  • Launch QDrant
docker compose up qdrant -d
  • Go to app/server
cd app/server
  • [Optionnal] Create a virtual environment
python -m venv venv
  • Install dependencies
pip install -r requirements.txt
  • Create vectors for QDrant
python -m app.scripts.create_vectors
  • Import vectors
python -m app.scripts.import_vectors
  • Create SVD model
python -m app.scripts.init_collaborative
  • [Optionnal] Build the project if you want to use docker
docker build -t quokka-server:latest .

Start server

Docker

  • Make sure you are in the root folder
  • Launch docker compose if you build the quokka-server image
docker compose up -d

Python

  • Make sure you are in the root folder
  • Launch the database
docker compose up qdrant -d
  • Go to app/server
cd app/server
  • Launch the server
uvicorn app.main:app --reload

Usage

You can find the OpenAPI documentation at http://localhost:8000/docs

Client

The client is made with Svelte.

Installation

Requirements

Setup

  • Go to app/client
cd app/client
  • Install dependencies
npm install

Start client

npm run dev

Usage

You can find the client at http://localhost:5173