bubbles-express-generator
Version:
A simple CLI to scaffold Express.js starter projects.
42 lines (33 loc) • 1.13 kB
Markdown
# Project Structure
## Root layout
```text
bubbles-express-generator/
├─ cli/
├─ templates/
├─ tests/
├─ documentation/project-docs/
├─ README.md
├─ CHANGELOG.md
├─ package.json
└─ eslint.config.js
```
## Key directories
- `cli/`: command entrypoint and scaffolding workflow.
- `templates/`: source templates for generated apps.
- `templates/agent-instructions/js`: optional `AGENTS.md` and `CLAUDE.md` for JS scaffolds.
- `templates/agent-instructions/ts`: optional `AGENTS.md` and `CLAUDE.md` for TS scaffolds.
- `tests/`: integration tests for CLI behavior.
- `documentation/project-docs/`: maintainers' focused documentation.
## Focused documentation files
- `documentation/project-docs/cli-behavior.md`
- `documentation/project-docs/output-style.md`
- `documentation/project-docs/configuration.md`
- `documentation/project-docs/templates.md`
- `documentation/project-docs/testing.md`
- `documentation/project-docs/dependencies.md`
- `documentation/project-docs/structure.md`
## Template variants
- `templates/js-mongo`
- `templates/js-pg`
- `templates/ts-mongo`
- `templates/ts-pg`