- Documentation
Getting Started
The fastest way to start using your application
First Time Here?
The app is already running — open your browser and log in. You don't need to install anything.
If you're looking at this page, you're already in.
What You'll See
- Left sidebar — navigation menu grouped into sections specific to your application
- Main area — the list for whichever table you're viewing
- Top bar — app title, your name, and logout
Try These First
Find a record: 1. Click any table in the left menu 2. Type part of a name or number in the search bar 3. Click the row to select it
See related records: 1. Select a row (above) 2. Look below the table — tabs appear with the record's related child records 3. Click through the tabs to explore; you can select rows inside them to drill deeper
Add a new record: 1. Open a table → click the Create button 2. Fill in the required fields (marked on the form) 3. Click Save
Learning Path
| I want to... | Go to... |
|---|---|
| Understand the screen layout | The Interface |
| Add my first record step-by-step | Your First Record |
| Understand parent-child navigation | Navigation |
| Learn my application's tables and workflows | Your application's section in the sidebar (below Framework Guides) |
| Get a quick answer | FAQ |
Common First-Time Questions
"I don't see any data" The database may be empty. Add your first record using the steps above, or ask your administrator to load data.
"I deleted something by accident" Nothing is permanently deleted. Contact your administrator — they can restore it.
"I don't know what a field means" Check your application's Quick Reference in the sidebar — application sections explain their tables and fields.
"The app won't load" Check with your administrator. The app runs on a server — if it's down, it needs to be restarted at the server level.
For Administrators: Starting the App
If you're running an app locally for development or testing:
# From the project root directory — use your application's name
python server/run.py <app_name>
# Examples:
python server/run.py container_tracking # http://localhost:5016
python server/run.py road_maintenance # http://localhost:5023
Each app's port is set in applications.yaml (list apps with
python server/run.py --list). The database lives at
apps/<app_name>/data/<app_name>.db and tables are created automatically on
first run.
See Local Development for full setup instructions.