Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix tests #24

Merged
merged 5 commits into from
Nov 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,44 +12,52 @@ VetsAI is an AI-powered virtual assistant designed to help veterans navigate emp
## Prerequisites

To run this application, ensure you have the following installed:

- Python 3.8 or later
- A virtual environment (recommended)

## Installation

1. **Clone the repository**:

```bash
git clone <repository-url>
cd <repository-directory>
```

2. **Set up a virtual environment**:

```bash
python -m venv venv
source venv/bin/activate # For macOS/Linux
.\venv\Scripts\activate # For Windows
```

3. **Install dependencies**:

```bash
pip install -r requirements.txt
```

4. **Set up environment variables**:

- Create a .env file in the root of your project.
- Add your OpenAI API key to the .env file:

```
OPENAI_API_KEY=your-openai-api-key
```

## Running the App

1. **Run the Streamlit app**:

```bash
streamlit run app.py
```

2. **Access the app**:

Open your web browser and navigate to http://localhost:8501.

## Usage
Expand All @@ -67,6 +75,7 @@ To run this application, ensure you have the following installed:
## Dependencies

The following Python libraries are required to run this app:

- `streamlit`: For the web interface.
- `httpx`: To make HTTP requests to OpenAI's API.
- `nest-asyncio`: To allow nested event loops for async operations.
Expand Down
Loading
Loading