virajsh/uniclare-client repository overview

⁠Overview

uniclare-client⁠ is a lightweight client for the Uniclare / Student Portal. It includes:

• FastAPI backend (/api)
• Frontend UI (/)
• MCP server (/mcp)
• Swagger documentation (/docs)

The /api path remains consistent across local development, Docker usage, and deployments.

⁠Quick Start

docker run -p 8000:8000 virajsh/uniclare-client:latest

⁠Available Services

Once the client is running, the following endpoints are accessible (the host may vary, but the paths remain the same):

• API: http://127.0.0.1:8000/api⁠

  • Swagger UI: http://127.0.0.1:8000/docs⁠

• Frontend: http://localhost:8000⁠

• MCP Server: http://localhost:8000/mcp⁠

⁠Features

• Single-container deployment
• Production-ready FastAPI backend
• Bundled frontend interface
• Built-in MCP server endpoint

⁠Docker Compose

A docker-compose.yaml⁠ is available in the GitHub repository:

https://github.com/viraj-sh/uniclare-client⁠