Customer Data App

This app is used to showcase and edit tabular data live in an app. It links up with a persistent database, such as Neon.

Usage

First clone the repo locally.

git clone https://github.com/reflex-dev/templates/tree/main/customer_data_app

Then set up a virtual environment as outlined in our documentation. After this run pip install -r requirements.txt.

First, create migration scripts based on the rx.Model definitions and update the default sqlite database with that schema. This only needs to be done once when a new app is created.

reflex db init

Then run the app with the following command:

reflex run

Applying Database Schema Changes

If changes are made to the database models after initialization, they can be applied by running the following commands:

reflex db makemigrations --message "Brief description of the change"

reflex db migrate

Setting an external Database

It is also possible to set an external database so that your data is not lost every time the app closes and so you can deploy your app and maintain data.

In the rxconfig.py file we accept a db_url key and recognize the DB_URL environment variable. This can be set to any valid SQLAlchemy database URL.

To set one run the following command in your terminal:

export DB_URL="postgresql+psycopg://appuser:mysecretpassword@localhost:5432/mydatabase"

Be sure to install the appropriate DB driver in your environment. In the *example above, that would be pip install "psycopg[binary]".

After configuring a different database, execute reflex db migrate to populate it with the latest schema before running the app.