Update README.md
Browse files
README.md
CHANGED
|
@@ -1,15 +1,17 @@
|
|
| 1 |
-
# Capybara
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
|
|
|
|
|
|
|
| 6 |
|
| 7 |
## Features
|
| 8 |
|
| 9 |
-
- AI-
|
| 10 |
-
- Personality classification based on user answers
|
| 11 |
- Saves personality summaries to text files
|
| 12 |
-
- Interactive web interface
|
| 13 |
|
| 14 |
## Requirements
|
| 15 |
|
|
@@ -23,39 +25,41 @@ Capybara Dating App is an interactive personality quiz that uses AI to generate
|
|
| 23 |
|
| 24 |
1. Clone this repository:
|
| 25 |
```
|
| 26 |
-
git clone https://github.com/yourusername/capybara-
|
| 27 |
-
cd capybara-
|
| 28 |
```
|
| 29 |
-
|
| 30 |
2. Install the required packages:
|
| 31 |
```
|
| 32 |
pip install -r requirements.txt
|
| 33 |
```
|
| 34 |
-
|
| 35 |
3. Set your OpenAI API key as an environment variable:
|
| 36 |
```
|
| 37 |
-
export
|
| 38 |
```
|
| 39 |
|
| 40 |
## Usage
|
| 41 |
|
| 42 |
-
1. Start the
|
| 43 |
```
|
| 44 |
-
python
|
| 45 |
```
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
|
| 49 |
-
3. Answer the questions presented by the app.
|
| 50 |
-
|
| 51 |
-
4. After answering 5 questions, you'll receive your personality classification.
|
| 52 |
-
|
| 53 |
5. A summary of your responses and personality classification will be saved as a text file in the project directory.
|
| 54 |
|
| 55 |
## File Structure
|
| 56 |
|
| 57 |
-
- `
|
| 58 |
-
- `
|
| 59 |
- `requirements.txt`: List of Python dependencies
|
| 60 |
- `README.md`: This file
|
| 61 |
-
- `capybara.mp4`: Introductory video about the
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Capybara Agent: AI-Powered Personality Quiz
|
| 2 |
|
| 3 |
+
Capybara Agent is an interactive personality quiz that uses AI to generate questions and classify users' personalities. It's built with Python (Flask) for the backend and HTML/JavaScript for the frontend.
|
| 4 |
|
| 5 |
+
## Introduction Video
|
| 6 |
+
|
| 7 |
+
[](https://www.youtube.com/watch?v=Zn7A01MHLOw)
|
| 8 |
|
| 9 |
## Features
|
| 10 |
|
| 11 |
+
- AI-powered Capybara Agent generates tailored questions based on previous responses
|
| 12 |
+
- Personality classification by the Capybara Agent based on user answers
|
| 13 |
- Saves personality summaries to text files
|
| 14 |
+
- Interactive web interface featuring the Capybara Agent
|
| 15 |
|
| 16 |
## Requirements
|
| 17 |
|
|
|
|
| 25 |
|
| 26 |
1. Clone this repository:
|
| 27 |
```
|
| 28 |
+
git clone https://github.com/yourusername/capybara-agent.git
|
| 29 |
+
cd capybara-agent
|
| 30 |
```
|
|
|
|
| 31 |
2. Install the required packages:
|
| 32 |
```
|
| 33 |
pip install -r requirements.txt
|
| 34 |
```
|
|
|
|
| 35 |
3. Set your OpenAI API key as an environment variable:
|
| 36 |
```
|
| 37 |
+
export Capx_API_KEY='your-api-key-here'
|
| 38 |
```
|
| 39 |
|
| 40 |
## Usage
|
| 41 |
|
| 42 |
+
1. Start the Capybara Agent server:
|
| 43 |
```
|
| 44 |
+
python capybara_agent.py
|
| 45 |
```
|
| 46 |
+
2. Open `capybara_agent.html` in your web browser.
|
| 47 |
+
3. Interact with the Capybara Agent by answering its questions.
|
| 48 |
+
4. After answering 5 questions, you'll receive your personality classification from the Capybara Agent.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 49 |
5. A summary of your responses and personality classification will be saved as a text file in the project directory.
|
| 50 |
|
| 51 |
## File Structure
|
| 52 |
|
| 53 |
+
- `capybara_agent.py`: Flask backend with Capybara Agent logic
|
| 54 |
+
- `capybara_agent.html`: Frontend HTML/JavaScript featuring the Capybara Agent
|
| 55 |
- `requirements.txt`: List of Python dependencies
|
| 56 |
- `README.md`: This file
|
| 57 |
+
- `capybara.mp4`: Introductory video about the Capybara Agent
|
| 58 |
+
|
| 59 |
+
## Contributing
|
| 60 |
+
|
| 61 |
+
Contributions to improve the Capybara Agent are welcome! Please feel free to submit pull requests or open issues to discuss potential enhancements.
|
| 62 |
+
|
| 63 |
+
## License
|
| 64 |
+
|
| 65 |
+
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
|