react-zayed
v2.0.0
Published
CLI full-stack React + Vite + Express + SQLite generator
Downloads
675
Maintainers
Readme
react-zayed – Full‑Stack App Generator
react-zayed is a CLI tool that scaffolds a full‑stack React + Vite + Express + SQLite project using the BasicTemplate in template/.
Instead of shipping a component library, this repo focuses on giving you a batteries‑included starter with:
- React + Vite frontend
- Tailwind CSS
- React Router
- Context API (App + Auth)
- Express backend
- SQLite + Drizzle ORM
The template/ directory contains the actual app you’ll generate; it has its own README and docs/ folder with detailed usage.
🧰 CLI usage
From npm (recommended)
Once [email protected] is published, you can scaffold a new app with:
npx react-zayed my-app
cd my-app
npm run devThis will:
- Copy the bundled
template/into./my-app. - Run
npm installinside./my-app. - Start a full‑stack setup:
- Frontend: React + Vite + Tailwind
- Backend: Express + Drizzle + SQLite
Local dev (working on this repo)
From this repo root:
# Clone this repo (if you haven't already)
git clone https://github.com/Lambdacoder09/react-starter.git
cd react-starter
# Install CLI dependencies
npm install
# Create a new app in ./my-app using the bundled template
node bin/create-react-bundle.js my-appThen inside the generated app:
cd my-app
npm run devInside the generated app you’ll find:
- A full‑stack template (frontend + backend + SQLite).
README.mdanddocs/with per‑part documentation.
If you publish this package to npm, you can also expose the CLI via the
binentry and run it asnpx react-zayed my-app.
🧱 Template contents
The template/ folder is what gets scaffolded into a new project. High‑level:
template/
├── backend/ # Express + SQLite + Drizzle
├── frontend/ # Vite + React + Tailwind
├── docs/ # overview.md, frontend.md, backend.md, database.md
└── README.md # Full‑stack template docsSee:
template/README.md– high‑level description + quickstart.template/docs/overview.md– scripts and project map.template/docs/frontend.md– pages, routes, context, styling.template/docs/backend.md– API routes and middleware.template/docs/database.md– SQLite + Drizzle details.
🧪 Testing this repo
For this CLI repo itself:
npm testThe test script currently runs a simple smoke check that require("./") works.
🚀 What’s new in 2.0.0
react-zayed 2.x is a breaking, CLI‑focused release:
- Breaking: The package is now positioned as a CLI full‑stack app generator, not a reusable UI component library.
- New: Bundled full‑stack template:
- Frontend: React + Vite + Tailwind, React Router, Context API.
- Backend: Express API (
backend/server.ts). - Database: SQLite via
better-sqlite3+ Drizzle (backend/db.ts,backend/drizzle/schema.ts).
- New: One‑command dev workflow in the generated app:
npm run dev– runs backend and frontend together.npm run dev:backend/npm run dev:frontend– run either side alone.
- New: Detailed template docs:
template/docs/overview.mdtemplate/docs/frontend.mdtemplate/docs/backend.mdtemplate/docs/database.md
🤝 Contributing
Contributions are welcome!
- Fork the repo.
- Create a feature branch:
git checkout -b feat/my-feature. - Make changes to the CLI and/or template.
- Run
npm testand try generating a new app via the CLI. - Open a pull request.
📝 License
This project is licensed under MIT — see the LICENSE file for details.
