Skip to content

Commit 64fb07c

Browse files
Merge pull request #1 from sahilsuman933/patch-1
Update README.md
2 parents 2857c87 + 1c5fdcc commit 64fb07c

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Server-Side Example Python Flask
2+
3+
This repository hosts a Python Flask application that demonstrates server-side operations with Flask. This project is structured to provide a straightforward example of how to manage API integrations and environment configurations.
4+
5+
## Prerequisites
6+
7+
Before you begin, ensure you have met the following requirements:
8+
- Python 3.6 or higher
9+
- Poetry for dependency management
10+
11+
## Installation
12+
13+
To install the necessary libraries and setup the project environment, follow these steps:
14+
15+
1. Clone the repository:
16+
```bash
17+
git clone https://github.com/VapiAI/server-side-example-python-flask.git
18+
2. Navigate to the project directory:
19+
```bash
20+
cd server-side-example-python-flask
21+
3. Install dependencies using Poetry:
22+
```bash
23+
poetry install
24+
## Configuring Environment Variables
25+
This project requires certain environment variables to be set. Create a .env file in the root directory of your project and add the following keys:
26+
27+
```bash
28+
WEATHER_API_KEY=<your_weather_api_key_here>
29+
OPENAI_API_KEY=<your_openai_api_key_here>
30+
VAPI_BASE_URL=https://api.vapi.ai
31+
VAPI_API_KEY=<your_vapi_api_key_here>
32+
```
33+
34+
Replace <your_weather_api_key_here>, <your_openai_api_key_here>, and <your_vapi_api_key_here> with the actual API keys.
35+
36+
## Running the Project
37+
To run the project, use Poetry to handle the environment:
38+
39+
```bash
40+
poetry run flask --app ./app/main run
41+
```
42+
43+
This command starts the Flask server on http://127.0.0.1:5000/. You can access the server from your web browser at this address.
44+

0 commit comments

Comments
 (0)