create-kor 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,47 @@
+# create-kor
+
+Scaffold a new **kor** full-stack monorepo in seconds.
+
+## Usage
+
+```bash
+pnpm create kor <project-name>
+# or
+npx create-kor <project-name>
+```
+
+This will:
+
+1. Clone the [kor](https://github.com/mastoj/kor) monorepo template into a new `<project-name>` directory
+2. Set the root `package.json` name to your project name
+3. Create `apps/web/.env.local` with a default API URL
+4. Initialise a fresh git repository with an initial commit
+
+## Getting started
+
+```bash
+cd <project-name>
+pnpm install
+pnpm dev
+```
+
+- **Web app** — [http://localhost:3000](http://localhost:3000)
+- **API** — [http://localhost:3001](http://localhost:3001)
+
+## What's inside
+
+The scaffolded project is a pnpm monorepo with:
+
+| Path | Description |
+|---|---|
+| `apps/web` | Next.js frontend (React Server Components, tRPC client) |
+| `apps/api` | Hono API server with tRPC router |
+| `packages/ui` | Shared UI components (Base UI) |
+| `packages/db` | Drizzle ORM schema & client (SQLite / PostgreSQL) |
+| `packages/domain` | Business logic / domain services |
+| `packages/shared` | Shared types and utilities |
+
+## Requirements
+
+- Node.js >= 20
+- pnpm

package/index.js

@@ -31,6 +31,9 @@ try {
   process.exit(1);
 }
 
+// Remove the scaffolding package from the generated project
+fs.rmSync(path.join(dest, "create-kor"), { recursive: true, force: true });
+
 // Update root package.json name
 const pkgPath = path.join(dest, "package.json");
 const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "create-kor",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Create a new kor project",
   "type": "module",
   "bin": {
     "create-kor": "./index.js"
   },
-  "files": ["index.js"],
+  "files": ["index.js", "README.md"],
   "dependencies": {
     "tiged": "^2.12.7"
   },