Repository files navigation

This is the base Reflex template - installed when you runreflex init.

If you want to use a different template, pass the--template flag toreflex init.For example, if you want a more basic starting point, you can run:

reflex init --template blank

This template has the following directory structure:

├── README.md├── assets├── rxconfig.py└── {your_app}    ├── __init__.py    ├── components    │   ├── __init__.py    │   └── sidebar.py    ├── pages    │   ├── __init__.py    │   ├── dashboard.py    │   ├── index.py    │   └── settings.py    ├── styles.py    ├── templates    │   ├── __init__.py    │   └── template.py    └── {your_app}.py

See theProject Structure docs for more information on general Reflex project structure.

In this template, the pages in your app are defined in{your_app}/pages/.Each page is a function that returns a Reflex component.For example, to edit this page you can modify{your_app}/pages/index.py.See thepages docs for more information on pages.

In this template, instead of usingrx.add_page or the@rx.page decorator,we use the@template decorator from{your_app}/templates/template.py.

To add a new page:

1. Add a new file in{your_app}/pages/. We recommend using one file per page, but you can also group pages in a single file.
2. Add a new function with the@template decorator, which takes the same arguments as@rx.page.
3. Import the page in your{your_app}/pages/__init__.py file and it will automatically be added to the app.

In order to keep your code organized, we recommend putting components that areused across multiple pages in the{your_app}/components/ directory.

In this template, we have a sidebar component in{your_app}/components/sidebar.py.

As your app grows, we recommend usingsubstatesto organize your state.

You can either define substates in their own files, or if the state isspecific to a page, you can define it in the page file itself.