diff --git a/README.md b/README.md new file mode 100644 index 0000000..a19aebd --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# stand + +An editable, filterable and sortable spreadsheet (via [AG Grid](https://www.ag-grid.com/)) webapp (via [NiceGUI](https://nicegui.io/)) with REST API (via [FastAPI](https://fastapi.tiangolo.com/)) using [Pandas](https://pandas.pydata.org/) [DataFrames](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html) backed by [ArcticDB](https://arcticdb.io/). + +## Setup the environment + +```bash +pixi install +``` + +## Start the webapp + +```bash +pixi shell +./stand.py +``` + +## Interact in the browser + +- **edit**: double click a cell +- **filter**: click the filter icon on a column head +- **sort**: click a column head (cycles through ascending, descending, chronological) +