Skip to content

MQushaym/Customize-ChainlitUI-2025

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

22 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ Live Demo

Test the live application right in your browser:

โžก๏ธ Click here to open the AI-GRC Assistant UI โฌ…๏ธ

Note: This demo is hosted on a free service (Render.com). If the app is inactive, please allow 15-30 seconds for the server to "wake up" on the first load.


๐ŸŒŸ Project Overview

This repository hosts the Customized User Interface (UI) for the AI-GRC Assistant. The interface is built using the Python library Chainlit and heavily customized to deliver a clean, professional, and compliant user experience (UX).

The project adheres to a Microservices Architecture by operating as a lightweight frontend client. Its sole responsibility is handling user interaction, sending queries to the designated backend API, and displaying the specialized RAG responses.

Screenshot of the customized GRC Assistant interface

๐Ÿš€ Key Features and Customization

This project highlights advanced frontend and integration skills by adapting a standard framework to meet specific professional needs:

  • Deep UI Customization: Custom CSS (stylesheet.css) and JavaScript (elements.js) were implemented to align the chat interface with professional standards.
    • Branding & Aesthetics: Custom styling was applied to the assistant's avatar/logo (emt.png) and chat elements.
    • UX Cleanup: Unnecessary default platform elements, such as the "New Chat" button and system watermarks, were hidden using JavaScript for a distraction-free experience.
  • Professional Configuration: The config.toml file is precisely configured to manage session timeouts, specify custom assets, and control the display of advanced features.
  • Decoupled API Integration: The core application logic (ui.py) uses the requests library to seamlessly communicate with the external FastAPI backend, ensuring the interface remains fast and independent of the complex RAG processing.

โš™๏ธ Tech Stack and Integration

Component Technology Purpose
UI Framework Chainlit (Customized) Core chatbot environment.
Frontend Logic Python (ui.py) + requests Handles user input and API communication.
Custom Styling CSS, JavaScript, TOML Configuration Defines the professional aesthetic and overrides default behavior.
Backend Dependency FastAPI API (Hosted on Hugging Face Space) Source of RAG-grounded, GRC compliance answers.

๐Ÿ”— Backend Service Link

All user queries are routed to the following live API endpoint:

  • Target API Endpoint: https://grc2025-grc.hf.space/ask
  • Backend Repository: [AI-GRC-Assistant-backend-2025 (GitHub Link)]

๐Ÿ› ๏ธ Local Setup Guide

1. Prerequisites

Ensure you have Python installed and install the required libraries:

pip install -r requirements.txt

2. Execution

To run the custom frontend locally and connect it to the live backend service:

chainlit run ui.py

The application will launch in your browser, ready to query the remote RAG backend for compliance advice.


๐Ÿค Contact

Detail Information
Author Meshal Qushaym
Email meshalqushim@outlook.com
GitHub Username MQushaym

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published