Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,61 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
# Capybara Dating App
|
| 5 |
+
|
| 6 |
+
Capybara Dating App is an interactive personality quiz that uses AI to generate questions and classify users' dating personalities. It's built with Python (Flask) for the backend and HTML/JavaScript for the frontend.
|
| 7 |
+
|
| 8 |
+
## Features
|
| 9 |
+
|
| 10 |
+
- AI-generated questions tailored to previous responses
|
| 11 |
+
- Personality classification based on user answers
|
| 12 |
+
- Saves personality summaries to text files
|
| 13 |
+
- Interactive web interface
|
| 14 |
+
|
| 15 |
+
## Requirements
|
| 16 |
+
|
| 17 |
+
- Python 3.8+
|
| 18 |
+
- Flask
|
| 19 |
+
- Flask-CORS
|
| 20 |
+
- LangChain
|
| 21 |
+
- OpenAI API key
|
| 22 |
+
|
| 23 |
+
## Installation
|
| 24 |
+
|
| 25 |
+
1. Clone this repository:
|
| 26 |
+
```
|
| 27 |
+
git clone https://github.com/yourusername/capybara-dating-app.git
|
| 28 |
+
cd capybara-dating-app
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
2. Install the required packages:
|
| 32 |
+
```
|
| 33 |
+
pip install -r requirements.txt
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
3. Set your OpenAI API key as an environment variable:
|
| 37 |
+
```
|
| 38 |
+
export OPENAI_API_KEY='your-api-key-here'
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
## Usage
|
| 42 |
+
|
| 43 |
+
1. Start the Flask server:
|
| 44 |
+
```
|
| 45 |
+
python capx/capybara_dating_app_api.py
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
2. Open `capx/capybara_dating_app.html` in your web browser.
|
| 49 |
+
|
| 50 |
+
3. Answer the questions presented by the app.
|
| 51 |
+
|
| 52 |
+
4. After answering 5 questions, you'll receive your personality classification.
|
| 53 |
+
|
| 54 |
+
5. A summary of your responses and personality classification will be saved as a text file in the project directory.
|
| 55 |
+
|
| 56 |
+
## File Structure
|
| 57 |
+
|
| 58 |
+
- `capybara_dating_app_api.py`: Flask backend
|
| 59 |
+
- `capybara_dating_app.html`: Frontend HTML/JavaScript
|
| 60 |
+
- `requirements.txt`: List of Python dependencies
|
| 61 |
+
- `README.md`: This file
|