Skip to content

Add virtual environment setup instructions to README #5913

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 22, 2025
+38 −8
Merged

Add virtual environment setup instructions to README #5913

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 38 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,25 +39,50 @@ See our [architecture page](https://reflex.dev/blog/2024-03-21-reflex-architectu

## ⚙️ Installation

Open a terminal and run (Requires Python 3.10+):

```bash
pip install reflex
```
**Important:** We strongly recommend using a virtual environment to ensure the `reflex` command is available in your PATH.

## 🥳 Create your first app

Installing `reflex` also installs the `reflex` command line tool.
### 1. Create the project directory

Test that the install was successful by creating a new project. (Replace `my_app_name` with your project name):
Replace `my_app_name` with your project name:

```bash
mkdir my_app_name
cd my_app_name
```

### 2. Set up a virtual environment

Create and activate virtual environment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Missing colon after "Create and activate virtual environment"

Suggested change
Create and activate virtual environment
Create and activate virtual environment:
Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 57:57

Comment:
**style:** Missing colon after "Create and activate virtual environment"

```suggestion
Create and activate virtual environment:
```

How can I resolve this? If you propose a fix, please make it concise.


```bash
# On Windows:
python -m venv .venv
.venv\Scripts\activate

# On macOS/Linux:
python3 -m venv .venv
source .venv/bin/activate
```

### 3. Install Reflex

Reflex is available as a pip package (Requires Python 3.10+):

```bash
pip install reflex
```

### 4. Initialize the project

This command initializes a template app in your new directory:

```bash
reflex init
```

This command initializes a template app in your new directory.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This avoids repeatation

### 5. Run the app

You can run this app in development mode:

Expand All @@ -69,6 +94,11 @@ You should see your app running at http://localhost:3000.

Now you can modify the source code in `my_app_name/my_app_name.py`. Reflex has fast refreshes so you can see your changes instantly when you save your code.

### Troubleshooting

If you installed Reflex without a virtual environment and the `reflex` command is not found, you can run commands using: `python3 -m reflex init` and `python3 -m reflex run`


## 🫧 Example App

Let's go over an example: creating an image generation UI around [DALL·E](https://platform.openai.com/docs/guides/images/image-generation?context=node). For simplicity, we just call the [OpenAI API](https://platform.openai.com/docs/api-reference/authentication), but you could replace this with an ML model run locally.
Expand Down