https://github.com/pdimens/brcapps
https://github.com/pdimens/brcapps
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pdimens/brcapps
- Owner: pdimens
- License: apache-2.0
- Created: 2025-06-19T19:17:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-13T16:22:45.000Z (12 months ago)
- Last Synced: 2025-08-13T18:37:33.367Z (12 months ago)
- Language: Python
- Homepage: https://pdimens.github.io/BRCapps/
- Size: 110 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BRC Convenience Webapps
This repository contains marimo-made interactive web apps to process BRC-specific data. The sections below detail how to add new
apps.
## Including data or assets
To include data or assets in your notebooks, add them to the `public/` directory.
For example, the `apps/charts.py` notebook loads an image asset from the `public/` directory.
```markdown
```
And the `notebooks/penguins.py` notebook loads a CSV dataset from the `public/` directory.
```python
import polars as pl
df = pl.read_csv(mo.notebook_location() / "public" / "penguins.csv")
```
## 🎨 Templates
This repository includes several templates for the generated site:
1. `index.html.j2` (default): A template with styling and a footer
2. `bare.html.j2`: A minimal template with basic styling
3. `tailwind.html.j2`: A minimal and lean template using Tailwind CSS
To use a specific template, pass the `--template` parameter to the build script:
```bash
uv run .github/scripts/build.py --template templates/tailwind.html.j2
```
You can also create your own custom templates. See the [templates/README.md](templates/README.md) for more information.
## 🧪 Testing
To test the export process, run `.github/scripts/build.py` from the root directory.
```bash
uv run .github/scripts/build.py
```
This will export all notebooks in a folder called `_site/` in the root directory. Then to serve the site, run:
```bash
python -m http.server -d _site
```
This will serve the site at `http://localhost:8000`.