Aasher commited on
Commit
6ed48d2
Β·
1 Parent(s): ea7e24e

resolve Readme.md issues

Browse files
.files/579e9671-1e26-420a-b7b1-0b98e63a41a8/edf107cd-7427-4110-8f20-b70a799736fd.png DELETED
Binary file (9.3 kB)
 
.github/README.md ADDED
@@ -0,0 +1,80 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ ```
.huggingface/README.md DELETED
@@ -1 +0,0 @@
1
- include: README_spaces.md
 
 
README.md CHANGED
@@ -1,80 +1,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
- ```
 
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README_spaces.md DELETED
@@ -1,10 +0,0 @@
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