Skip to content
akshayram1Public

About

Finsk document knowledge graph

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Finsk

Finsk is a university knowledge graph and skill-based placement system with a FastAPI backend and a Next.js frontend.

Project Structure

Finsk/
├── .env              # single env file for backend and frontend
├── Makefile          # Mac/Linux: make install / make run
├── install.bat       # Windows: install dependencies
├── run.bat           # Windows: start backend and frontend
├── backend/          # FastAPI API, Qdrant search & Groq LLM integration
└── frontend/         # Next.js web application

Quick start

Copy the env file once, then install and run.

cp .env.example .env

On Windows Command Prompt, that copy is:

copy .env.example .env

Fill in the Qdrant and Groq keys in .env before the first run.

Mac or Linux

make install
make run

Windows

make is not required. From the project folder in Command Prompt or PowerShell:

install.bat
run.bat

In PowerShell, prefix them with .\ if Windows asks you to:

.\install.bat
.\run.bat

install creates backend/.venv, installs the Python packages, and installs the frontend npm packages.

run starts the backend and the frontend together. Ctrl+C stops both.

How it works

  • Workspace (/): every uploaded PDF or CSV becomes its own document graph. From here you add documents and open chat windows. Tick several document cards to start one chat across all of them.
  • Chat (/chat/<id>): each chat is scoped to the graphs ticked in the "Chatting with" bar, and you can change that at any time. Answers come only from those graphs. When several are selected, entities that appear in more than one document are linked and passed to the model. Source chips jump to the node in the graph beside the chat.
  • Graph explorer (/graph?ids=a,b): a full-screen graph for any set of documents. Layouts: Network, By document, By type. You also get search, type filters, and a node inspector.

Nodes, document names, and chats all live in Qdrant. Each node is tagged with graph_id plus the document name, so every machine using the same Qdrant collection sees the same documents. Chats are in the <collection>__workspace collection.

Environment

One file, at the project root: .env.

The backend and the frontend both read that one file. NEXT_PUBLIC_API_URL is the address the browser uses to call the API.

Do not commit .env. It stays on your machine. The repo only includes .env.example, which has placeholders.

About

Finsk document knowledge graph

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages