sumedhphadke commited on
Commit
9758a71
·
1 Parent(s): 9433f90

updated versions

Browse files
Files changed (2) hide show
  1. README.md +62 -1
  2. requirements.txt +2 -2
README.md CHANGED
@@ -22,9 +22,70 @@ A friendly Math Tutor AI agent built with Chainlit and LangChain, powered by Ant
22
 
23
  ## Setup
24
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
25
  1. Set your `ANTHROPIC_API_KEY` in the Space secrets
26
  2. The app will automatically deploy when code is pushed
27
 
28
  ## Usage
29
 
30
- Simply start chatting! The AI tutor will help explain math concepts in a fun and encouraging way.
 
22
 
23
  ## Setup
24
 
25
+ ### Local Development
26
+
27
+ 1. **Create and activate a virtual environment:**
28
+
29
+ **Windows (PowerShell):**
30
+ ```powershell
31
+ python -m venv venv
32
+ .\venv\Scripts\Activate.ps1
33
+ ```
34
+
35
+ **Windows (CMD):**
36
+ ```cmd
37
+ python -m venv venv
38
+ venv\Scripts\activate.bat
39
+ ```
40
+
41
+ **Linux/Mac:**
42
+ ```bash
43
+ python -m venv venv
44
+ source venv/bin/activate
45
+ ```
46
+
47
+ 2. **Install dependencies:**
48
+ ```bash
49
+ pip install -r requirements.txt
50
+ ```
51
+
52
+ 3. **Set up your API key:**
53
+
54
+ Create a `.env` file in the project root:
55
+ ```bash
56
+ ANTHROPIC_API_KEY=your_api_key_here
57
+ ```
58
+
59
+ Or set it as an environment variable:
60
+ - **Windows (PowerShell):**
61
+ ```powershell
62
+ $env:ANTHROPIC_API_KEY="your_api_key_here"
63
+ ```
64
+ - **Windows (CMD):**
65
+ ```cmd
66
+ set ANTHROPIC_API_KEY=your_api_key_here
67
+ ```
68
+ - **Linux/Mac:**
69
+ ```bash
70
+ export ANTHROPIC_API_KEY=your_api_key_here
71
+ ```
72
+
73
+ 4. **Run the application:**
74
+ ```bash
75
+ chainlit run app.py
76
+ ```
77
+
78
+ The app will start on `http://localhost:8000` by default.
79
+
80
+ 5. **Access the chat interface:**
81
+ - Open your browser and navigate to `http://localhost:8000`
82
+ - Start chatting with the AI agent!
83
+
84
+ ### Hugging Face Spaces Deployment
85
+
86
  1. Set your `ANTHROPIC_API_KEY` in the Space secrets
87
  2. The app will automatically deploy when code is pushed
88
 
89
  ## Usage
90
 
91
+ Simply start chatting! The AI agent will guide you through the Design Thinking process.
requirements.txt CHANGED
@@ -1,6 +1,6 @@
1
- chainlit==1.0.200
2
  langchain
3
  langchain-anthropic
4
  python-dotenv
5
- pydantic<2.10.2
6
  websockets
 
1
+ chainlit
2
  langchain
3
  langchain-anthropic
4
  python-dotenv
5
+ pydantic
6
  websockets