create-effect-project 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michael
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# create-effect-project
+
+Scaffolds an [Effect](https://effect.website) v4 project on Node or Bun — an HttpApi server, a
+full-stack app, a plain program, or a Cloudflare Worker.
+
+```bash
+npx create-effect-project
+```
+
+That prompts for everything. Pass flags instead and nothing prompts, so the same command works in
+a terminal and in CI:
+
+```bash
+npx create-effect-project --name my-api  --template http-server --runtime bun
+npx create-effect-project --name my-app  --template basic --runtime node --no-otel --no-lint
+```
+
+`npm create effect-project` and `yarn create effect-project` work too.
+
+## Templates
+
+| `--template` | What you get |
+| --- | --- |
+| `http-server` | A schema-first `HttpApi`. One definition produces the server routes, an OpenAPI document at `/openapi.json`, Scalar docs at `/docs`, and a typed client checked against the server at compile time |
+| `fullstack` | The same `HttpApi` behind both a server and a server-rendered React UI — a workspace whose TanStack Start frontend drives its data through Effect's own reactivity, hydrated from SSR |
+| `basic` | A runnable program: a `Context.Service` with an in-memory layer, a branded id, a typed error, and a `main` that handles it. No server |
+| `alchemy-http` | The same `HttpApi` deployed to a Cloudflare Worker with [Alchemy](https://alchemy.run) — infrastructure as Effects, no `wrangler.toml` |
+| `alchemy-rpc` | The same service exposed as typed RPC on a Worker, so typed errors cross the wire as themselves rather than as status codes |
+
+Four of the five serve the same Notes domain from identical source files, so switching template
+changes the transport and nothing else.
+
+## Flags
+
+| Flag | Default | Meaning |
+| --- | --- | --- |
+| `--name`, `-n` | prompted | Directory and package name |
+| `--template`, `-t` | prompted | `http-server`, `fullstack`, `basic`, `alchemy-http` or `alchemy-rpc` |
+| `--runtime` | prompted | `node` or `bun` |
+| `--pm` | prompted (node) | `npm`, `pnpm`, `yarn` or `bun`. Bun projects use bun; node projects are asked, with the detected manager pre-selected |
+| `--no-otel` | on | Skip OTLP logs, metrics and traces |
+| `--no-lint` | on | Skip oxlint, the `@effect/tsgo` language service, and `.vscode/settings.json` |
+| `--slop` | off | Add stricter oxlint rules that reject sloppy code (needs `--lint`) |
+| `--no-install` | installs | Skip dependency installation |
+| `--no-git` | initialises | Skip `git init` |
+
+## What you get
+
+No build step — Node and Bun both execute TypeScript directly, so there is nothing between editing
+a file and running it. (The `fullstack` template's web app is the exception; Vite builds it.)
+
+Every template comes with tests that pass, a typecheck that passes, and a lint that passes, on
+both runtimes. Whichever package manager you choose is used for the install *and* for the commands
+the generated files document, so a pnpm project reads `pnpm run dev`, not `npm run dev`.
+
+With `--lint` (the default) you also get the Effect language service, which reports Effect-specific
+mistakes through `tsc` — a floating Effect fails `typecheck` rather than surviving to runtime — plus
+the editor settings that make those diagnostics show up in VS Code.
+
+## Requirements
+
+Node 20+ to run the scaffolder. Generated projects ask for more in their own manifests: Node 22.6+
+for native TypeScript execution, or Bun 1.3+.
+
+## Contributing
+
+See [docs/internals.md](docs/internals.md) for how the template registry works, how to add a
+template, and how the package is built, tested and released.
+
+## License
+
+MIT