@effect-gql/node 1.0.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -1
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -11,7 +11,33 @@ A GraphQL framework for Effect-TS that brings full type safety, composability, a
11
11
  - **Immutable Builder** - Fluent, pipe-able API for composing schemas from reusable parts
12
12
  - **Service Integration** - Use Effect's Layer system for dependency injection
13
13
 
14
- ## Installation
14
+ ## Getting Started
15
+
16
+ The easiest way to get started is with the CLI:
17
+
18
+ ```bash
19
+ # Create a new project
20
+ npx @effect-gql/cli create my-api --server-type node
21
+
22
+ # Start the dev server
23
+ cd my-api
24
+ npm run dev
25
+ ```
26
+
27
+ Your GraphQL server will be running at http://localhost:4000/graphql with a GraphiQL playground at http://localhost:4000/graphiql.
28
+
29
+ ### Server Types
30
+
31
+ The CLI supports multiple server runtimes:
32
+
33
+ | Type | Command | Best For |
34
+ |------|---------|----------|
35
+ | Node.js | `--server-type node` | General Node.js deployments |
36
+ | Bun | `--server-type bun` | Bun runtime with native WebSocket support |
37
+ | Express | `--server-type express` | Integrating into existing Express apps |
38
+ | Web | `--server-type web` | Cloudflare Workers, Deno, edge runtimes |
39
+
40
+ ## Manual Installation
15
41
 
16
42
  ```bash
17
43
  npm install @effect-gql/core effect graphql
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effect-gql/node",
3
- "version": "1.0.0",
3
+ "version": "1.3.0",
4
4
  "description": "Node.js HTTP server integration for @effect-gql/core",
5
5
  "repository": {
6
6
  "url": "https://github.com/nrf110/effect-gql"
@@ -17,8 +17,8 @@
17
17
  }
18
18
  },
19
19
  "peerDependencies": {
20
- "@effect-gql/core": "^1.0.0",
21
- "@effect/platform": "^0.94.0",
20
+ "@effect-gql/core": "^1.3.0",
21
+ "@effect/platform": "^0.94.1",
22
22
  "@effect/platform-node": "^0.104.0",
23
23
  "effect": "^3.19.0",
24
24
  "graphql": "^16.0.0",