Running Your App

M
Written By Melih SünbülLast updated 5 months ago

Once you've installed and initialized your Lex App application, you can run it locally. We recommend using PyCharm (the run configurations handle everything automatically), but the terminal works just as well.

Using PyCharm

The lex setup command generates ready-to-use run configurations in the .run/ folder. Open the Run Configuration dropdown in the top-right toolbar and you'll see:

Configuration

What It Does

Init

Applies migrations and syncs to Keycloak

Start

Starts the development server

Streamlit

Runs the Streamlit dashboard server

Select "Start" and click the green ▶️ button. Your app is now running at http://localhost:8000.

PyCharm run configurations automatically load your .env file. No manual sourcing needed.

Using the Terminal

If you're not using PyCharm, you'll need to load environment variables manually before running any lex command:

# Load environment variables
set -a; source .env; set +a

# Start the development server
lex start --reload --loop asyncio lex_app.asgi:application

The --reload flag enables hot-reloading so the server restarts automatically when you change code.

Running Streamlit Dashboards

If your models define Streamlit dashboards, you need to start the Streamlit server separately:

Via PyCharm

Select "Streamlit" from the Run Configuration dropdown.

Via Terminal

set -a; source .env; set +a
lex streamlit

PyCharm's Streamlit run configuration handles all environment variables automatically. We recommend using it for local development.

What's Next?

Now that your app is running, explore the features to see what Lex App gives you out of the box. If you want a guided walkthrough, try the TeamBudget Tutorial.

Was this helpful?

Your feedback shapes what we write next.