Write Readme for github
Browse files- .chainlit/config.toml +2 -2
- .env.example +1 -0
- .files/579e9671-1e26-420a-b7b1-0b98e63a41a8/edf107cd-7427-4110-8f20-b70a799736fd.png +0 -0
- .huggingface/README.md +1 -0
- README.md +80 -10
- README_spaces.md +10 -0
.chainlit/config.toml
CHANGED
|
@@ -49,8 +49,8 @@ edit_message = true
|
|
| 49 |
# 3. For specific file extensions:
|
| 50 |
# accept = { "application/octet-stream" = [".xyz", ".pdb"] }
|
| 51 |
# Note: Using "*/*" is not recommended as it may cause browser warnings
|
| 52 |
-
accept = ["image/
|
| 53 |
-
max_files =
|
| 54 |
max_size_mb = 5
|
| 55 |
|
| 56 |
[features.audio]
|
|
|
|
| 49 |
# 3. For specific file extensions:
|
| 50 |
# accept = { "application/octet-stream" = [".xyz", ".pdb"] }
|
| 51 |
# Note: Using "*/*" is not recommended as it may cause browser warnings
|
| 52 |
+
accept = ["image/jpeg", "image/png", "image/webp", "image/jpg"]
|
| 53 |
+
max_files = 2
|
| 54 |
max_size_mb = 5
|
| 55 |
|
| 56 |
[features.audio]
|
.env.example
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
GOOGLE_API_KEY=
|
.files/579e9671-1e26-420a-b7b1-0b98e63a41a8/edf107cd-7427-4110-8f20-b70a799736fd.png
ADDED
|
.huggingface/README.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
include: README_spaces.md
|
README.md
CHANGED
|
@@ -1,10 +1,80 @@
|
|
| 1 |
-
-
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
-
|
| 9 |
-
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Axiom - A Docs Expert Agent
|
| 2 |
+
|
| 3 |
+
Axiom is an AI Docs Agent built with LangGraph, MCP Docs, Chainlit and Gemini, designed to help users create different projects using natural language.
|
| 4 |
+
|
| 5 |
+
## Features
|
| 6 |
+
|
| 7 |
+
- π€ Interactive chat interface
|
| 8 |
+
- π Access to multiple documentation sources
|
| 9 |
+
- π¨ Support for image processing and analysis
|
| 10 |
+
- π Use images and graphs to create production-ready code
|
| 11 |
+
- π οΈ Customizable model settings (temperature, model version)
|
| 12 |
+
- π Docker support for containerized deployment
|
| 13 |
+
|
| 14 |
+
## Documentation Sources
|
| 15 |
+
|
| 16 |
+
The agent has access to following documentations:
|
| 17 |
+
- LangGraph Python
|
| 18 |
+
- CrewAI
|
| 19 |
+
- Model Context Protocol (MCP)
|
| 20 |
+
- Chainlit
|
| 21 |
+
- FastHTML
|
| 22 |
+
- Supabase
|
| 23 |
+
- Pinecone
|
| 24 |
+
- Composio
|
| 25 |
+
- Clerk Auth
|
| 26 |
+
- Stack Auth
|
| 27 |
+
- Mem0
|
| 28 |
+
- Zep
|
| 29 |
+
|
| 30 |
+
## Prerequisites
|
| 31 |
+
|
| 32 |
+
* UV package manager
|
| 33 |
+
* Python 3.11+
|
| 34 |
+
* Docker (optional): If you intend to use the `Dockerfile`, you'll need Docker installed.
|
| 35 |
+
|
| 36 |
+
## Installation
|
| 37 |
+
|
| 38 |
+
1. Clone the repository:
|
| 39 |
+
```bash
|
| 40 |
+
git clone https://github.com/aasherkamal216/Axiom.git
|
| 41 |
+
cd Axiom
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
2. Create and Activate Virtual Environment:
|
| 45 |
+
```bash
|
| 46 |
+
uv venv
|
| 47 |
+
.venv\Scripts\activate # For Windows
|
| 48 |
+
source .venv/bin/activate # for Mac
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
3. Install dependencies:
|
| 52 |
+
```bash
|
| 53 |
+
uv sync
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
4. Set up environment variables:
|
| 57 |
+
```bash
|
| 58 |
+
cp .env.example .env
|
| 59 |
+
```
|
| 60 |
+
Add your API keys in `.env` file.
|
| 61 |
+
|
| 62 |
+
## Usage
|
| 63 |
+
### Run the application:
|
| 64 |
+
- First run the MCP Doc server:
|
| 65 |
+
```bash
|
| 66 |
+
uv run mcpdoc --yaml docs_config.yaml --transport sse --port 8082 --host localhost
|
| 67 |
+
```
|
| 68 |
+
- Then run chainlit interface:
|
| 69 |
+
```bash
|
| 70 |
+
uv run chainlit run app.py -w
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
The application will be available at `http://localhost:8000`.
|
| 74 |
+
|
| 75 |
+
### Building the Docker image (Optional)
|
| 76 |
+
Alternatively, you can use Docker to run the application:
|
| 77 |
+
```bash
|
| 78 |
+
docker build -t axiom .
|
| 79 |
+
docker run -p 7860:7860 -p 8082:8082 axiom
|
| 80 |
+
```
|
README_spaces.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Documentations Agent
|
| 3 |
+
emoji: π’
|
| 4 |
+
colorFrom: purple
|
| 5 |
+
colorTo: yellow
|
| 6 |
+
sdk: docker
|
| 7 |
+
pinned: false
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|