create-bdpa-react-scaffold

Scaffold a ready-to-run React + Tailwind UI library demo built with Vite. This CLI creates a project with common UI components and a demo app.

Quick Start

Run with npx (no global install needed):

``bash
npx create-bdpa-react-scaffold my-app
`

Then start the dev server:

`bash
cd my-app
npm install
npm run dev
`

Options

- --pm : Choose package manager (default: npm).
- --no-install: Skip dependency installation.
- --force: Allow writing into a non-empty directory.

Examples:

`bash
npx create-bdpa-react-scaffold my-app --pm pnpm
npx create-bdpa-react-scaffold . --force --no-install
`

What You Get

- Vite + React 18 project
- Tailwind CSS configured (postcss.config.cjs, tailwind.config.cjs)
- Example UI components (Button, Card, Input, FormField, Table, Navbar, Sidebar, Modal, Tabs, Toast)
- Simple Auth pages (Login, Register)
- Demo app and wiring
- Axios-based API client with CRUD helpers (src/utils/api.js)

Local Development (for this CLI)

Link the CLI locally to test changes without publishing:

`bash
npm install
npm link

Now you can run it from anywhere


create-bdpa-react-scaffold my-test-app --no-install
`

To unlink later:

`bash
npm unlink -g create-bdpa-react-scaffold
`

Publishing to npm

1) Pick a unique package name. This repo uses create-bdpa-react-scaffold.

2) Login to npm:

`bash
npm login
`

3) Publish (public):

`bash
npm publish --access public
`

If your package name is scoped (e.g. @yourname/create-bdpa-react-scaffold), include --access public on first publish.

After publishing, users can run:

`bash
npx create-bdpa-react-scaffold my-app
``

Documentation

- How-To Guides - Learn how to add pages and make API calls

License

UNLICENSED (update as desired).