create-featurebased-architecture 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+# create-featurebased-architecture-backend
+
+A CLI tool to scaffold feature-based architecture projects with Bun, Hono, and React.
+
+## Usage
+
+```bash
+npx create-featurebased-architecture-backend
+```
+
+Or with bun:
+
+```bash
+bunx create-featurebased-architecture-backend
+```
+
+## Templates
+
+| Template | Description |
+|----------|-------------|
+| **Blank Hono** (default) | Feature-based Hono backend with NeonDB setup |
+| **Blank TS** | Feature-based TypeScript project |
+| **React** | Feature-based React frontend with Vite |
+| **User Management Backend** | Complete CRUD backend for users with NeonDB |
+| **User Management Frontend** | React frontend for user management |
+
+## Feature-Based Architecture
+
+Each feature is self-contained with its own:
+- Routes (API endpoints)
+- Controller (request handling)
+- Service (business logic)
+- Repository (data access)
+- Types (TypeScript interfaces)
+- Schema (validation)
+
+## Database Setup (NeonDB)
+
+For templates using NeonDB, run this SQL to create the users table:
+
+```sql
+CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
+
+CREATE TABLE users (
+  id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
+  email VARCHAR(255) UNIQUE NOT NULL,
+  name VARCHAR(100) NOT NULL,
+  created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
+  updated_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
+);
+
+CREATE INDEX idx_users_email ON users(email);
+
+CREATE OR REPLACE FUNCTION update_updated_at_column()
+RETURNS TRIGGER AS $$
+BEGIN
+  NEW.updated_at = CURRENT_TIMESTAMP;
+  RETURN NEW;
+END;
+$$ language 'plpgsql';
+
+CREATE TRIGGER update_users_updated_at
+  BEFORE UPDATE ON users
+  FOR EACH ROW
+  EXECUTE FUNCTION update_updated_at_column();
+```
+
+## Development
+
+```bash
+# Install dependencies
+bun install
+
+# Run CLI locally
+bun run dev
+
+# Build for publishing
+bun run build
+```
+
+## Publishing
+
+```bash
+npm publish
+```
+
+## License
+
+MIT