Skip to content

Commit 9e2d798

Browse files
authored
Merge pull request #30 from reflex-dev/elijah/sales-template-readme
[ENG-3795]Add readme for sales app
2 parents 25bdd07 + 5a3c7e7 commit 9e2d798

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

sales/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Sales Template - Quick Start Guide
2+
Welcome to your new sales app template! This template is built with Reflex and integrates OpenAI for enhanced AI-driven features.
3+
4+
## Setup Instructions
5+
Follow these steps to get your app up and running quickly.
6+
7+
## 1. Install Dependencies
8+
First, install all the necessary dependencies:
9+
10+
```shell
11+
pip install -r requirements.txt
12+
```
13+
## 2. Set Your OpenAI API Key
14+
To utilize OpenAI in this template, you need to set your OPEN_AI_KEY environment variable. Here’s how you can set it based on your operating system:
15+
16+
### On Linux / macOS:
17+
```shell
18+
export OPEN_AI_KEY=your-openai-api-key
19+
```
20+
21+
### On Windows (Command Prompt):
22+
```shell
23+
set OPEN_AI_KEY=your-openai-api-key
24+
```
25+
26+
### On Windows (PowerShell):
27+
```shell
28+
$env:OPEN_AI_KEY="your-openai-api-key"
29+
```
30+
31+
### 3. Run the App
32+
After setting up your environment variable, you can start the app:
33+
34+
```shell
35+
reflex run
36+
```
37+
This will launch the app locally and you can interact with it in your browser.
38+
39+
### Notes
40+
- Make sure you have your OpenAI API key. If you don’t have one, you can get it by signing up at [OpenAI](https://openai.com/api/).
41+
- You can permanently set the environment variable in your shell configuration (e.g., `.bashrc` or `.zshrc` for Linux/macOS) to avoid setting it every time.
42+
Enjoy building with Reflex and OpenAI!
43+

0 commit comments

Comments
 (0)