Hassan Ali Khan commited on
Commit
0e5a76c
·
1 Parent(s): c03605c
Files changed (1) hide show
  1. README.md +10 -81
README.md CHANGED
@@ -1,83 +1,12 @@
1
- # Study Chatbot
2
-
3
- A simple Chainlit-based echo chatbot that responds with the same message it receives.
4
-
5
- ## Features
6
-
7
- - Echoes back any text message sent to it.
8
- - Built with Chainlit for conversational AI applications.
9
-
10
- ## Installation
11
-
12
- This project uses `uv` for dependency management. Ensure you have `uv` installed.
13
-
14
- 1. Clone or navigate to the project directory.
15
- 2. Install dependencies:
16
- ```bash
17
- uv sync
18
- ```
19
-
20
-
21
-
22
- ## Running the Application
23
-
24
- To run the Chainlit app locally:
25
-
26
- ```bash
27
- uv run chainlit run src/study_chatbot/app.py
28
- ```
29
-
30
- This will start the Chainlit server, and you can interact with the chatbot via the web interface at `http://localhost:8000`.
31
-
32
- ### Custom UI and Styling
33
-
34
- This project includes comprehensive UI customization following Chainlit's official documentation:
35
 
36
- - **`.chainlit/config.toml`**: Main configuration file with UI settings, dark theme, and custom CSS reference
37
- - **`public/stylesheet.css`**: Custom CSS stylesheet with modern dark theme, gradients, and animations
38
- - **`public/favicon.png`**: Custom favicon served from the public directory
39
-
40
- The styling includes:
41
- - Dark gradient background theme
42
- - Custom message bubbles with animations
43
- - Improved input styling and buttons
44
- - Custom scrollbars and typography
45
- - Visual indicator to confirm CSS is loading
46
-
47
- Chainlit automatically serves files from the `public/` directory, making them accessible via `/public/filename`.
48
-
49
- ## Usage
50
-
51
- Send any text message to the chatbot, and it will echo the same text back to you.
52
-
53
- ## Development
54
-
55
- - Python version: >=3.13
56
- - Main dependencies: Chainlit, OpenAI Agents, python-dotenv, Rich
57
-
58
- ### Running Tests
59
-
60
- Install test dependencies and run the test suite:
61
-
62
- ```bash
63
- uv sync --extra test
64
- uv run pytest tests/ -v
65
- ```
66
-
67
- ### Environment Variables
68
-
69
- Copy `.env.example` to `.env` and customize settings:
70
-
71
- ```bash
72
- cp .env.example .env
73
- ```
74
-
75
- Available environment variables:
76
- - `CHAINLIT_HOST`: Server bind address (default: 0.0.0.0)
77
- - `CHAINLIT_PORT`: Server port (default: 8000)
78
- - `CHAINLIT_THEME`: UI theme - light/dark/system (default: system)
79
- - `APP_NAME`: Application display name
80
-
81
- ## License
82
 
83
- Add your license here.
 
1
+ ---
2
+ title: Study Chatbot
3
+ emoji: 🤖
4
+ colorFrom: indigo
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
 
10
+ # Study Chatbot
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
 
12
+ A Chainlit app running with Gemini API, deployed on Hugging Face Spaces (Docker).