ui_poc/README.md

29 lines
590 B
Markdown
Raw Normal View History

# Dashboard UI
2024-09-06 00:50:11 +00:00
## Introduction
This is a proof-of-concept of a basic Dashboard UI in Python using FastApi and HTMX.
## Deploy Locally
```
# Clone the repository
git clone https://git.ourworld.tf/tfgrid/ui_poc
# Go to backend
cd ui_poc/backend
# Set Python environment
python3 -m venv venv
source venv/bin/activate
# Install requirements
python3 -m pip install -r requirements.txt
# Deploy the local website at port 8000
uvicorn main:app --reload
```
## Notes
2024-09-06 01:02:05 +00:00
The .gitignore file is set with `venv` as the Python virtual environment.
## Overview
![dashboard_1](./img/dashboard_1.png)