le-app/README.md

40 lines
1.3 KiB
Markdown

# Laser Everything Database
Monorepo for the Laser Everything database application and its supporting
services.
## Components
- `app/` — main Next.js application
- `bgbye/` — customized background-removal service
- `dashboard/` — static application dashboard
- `svgnest/` — customized SVG nesting application
- `app/files/` — curated manuals, reference material, software and projects
- `docker-compose.yml` — production service definition
## Runtime data excluded from Git
The following are created or downloaded on the deployment host and are not
stored in this repository:
- environment and secret files;
- JavaScript dependencies and Next.js build output;
- Python virtual environments;
- BGBye model downloads and caches;
- logs and temporary files.
The production environment currently expects:
- `app/.env.local`
- `bgbye/.cache/`
- `bgbye/.u2net/`
- `bgbye/.ormbg/`
These must be provisioned separately when deploying a fresh checkout.
## Repository structure
This repository replaces several older nested repositories. BGBye and SVGnest
are incorporated directly as locally maintained source trees rather than Git
submodules or automatically updated upstream dependencies. See their
`UPSTREAM.md` files and `LEGACY_REPOSITORIES.md` for provenance.