create-cloudflare 0.0.0-7e908bf2 → 0.0.0-7ede18113
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.
- package/dist/cli.js +47115 -45798
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/package.json +28 -25
- package/templates/analog/c3.ts +135 -0
- package/templates/analog/snippets/devBindingsModule.ts +7 -0
- package/templates/analog/templates/env.d.ts +13 -0
- package/templates/analog/templates/src/dev-bindings.ts +18 -0
- package/templates/analog/templates/worker-configuration.d.ts +4 -0
- package/templates/analog/templates/wrangler.toml +85 -0
- package/templates/angular/c3.ts +4 -2
- package/templates/astro/c3.ts +9 -8
- package/templates/astro/snippets/runtimeDeclaration.ts +2 -1
- package/templates/astro/templates/wrangler.toml +35 -2
- package/templates/common/c3.ts +3 -0
- package/templates/common/js/package.json +1 -1
- package/templates/common/js/wrangler.toml +17 -1
- package/templates/common/ts/package.json +4 -3
- package/templates/common/ts/src/ab-test.ts +2 -2
- package/templates/common/ts/src/index.ts +5 -2
- package/templates/common/ts/src/proxy.ts +2 -2
- package/templates/common/ts/src/redirect.ts +2 -2
- package/templates/common/ts/tsconfig.json +1 -1
- package/templates/common/ts/worker-configuration.d.ts +2 -14
- package/templates/common/ts/wrangler.toml +17 -1
- package/templates/docusaurus/c3.ts +1 -0
- package/templates/gatsby/c3.ts +1 -0
- package/templates/hello-world/c3.ts +5 -1
- package/templates/hello-world/js/package.json +5 -4
- package/templates/hello-world/js/test/index.spec.js +17 -17
- package/templates/hello-world/js/vitest.config.js +8 -8
- package/templates/hello-world/js/wrangler.toml +17 -1
- package/templates/hello-world/py/__dot__gitignore +68 -0
- package/templates/hello-world/py/package.json +13 -0
- package/templates/hello-world/py/src/entry.py +4 -0
- package/templates/hello-world/py/wrangler.toml +114 -0
- package/templates/hello-world/ts/package.json +6 -5
- package/templates/hello-world/ts/src/index.ts +5 -19
- package/templates/hello-world/ts/test/index.spec.ts +17 -17
- package/templates/hello-world/ts/test/tsconfig.json +6 -9
- package/templates/hello-world/ts/tsconfig.json +3 -2
- package/templates/hello-world/ts/vitest.config.mts +11 -0
- package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
- package/templates/hello-world/ts/wrangler.toml +17 -1
- package/templates/hello-world-durable-object/c3.ts +3 -1
- package/templates/hello-world-durable-object/js/package.json +1 -1
- package/templates/hello-world-durable-object/js/src/index.js +18 -14
- package/templates/hello-world-durable-object/js/wrangler.toml +18 -2
- package/templates/hello-world-durable-object/ts/package.json +4 -4
- package/templates/hello-world-durable-object/ts/src/index.ts +24 -37
- package/templates/hello-world-durable-object/ts/tsconfig.json +1 -1
- package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
- package/templates/hello-world-durable-object/ts/wrangler.toml +19 -4
- package/templates/hono/c3.ts +44 -0
- package/templates/hono/snippets/appDeclaration.ts +1 -0
- package/templates/hono/templates/worker-configuration.d.ts +4 -0
- package/templates/hono/templates/wrangler.toml +113 -0
- package/templates/next/README.md +7 -7
- package/templates/next/app/js/app/api/hello/route.js +1 -1
- package/templates/next/app/ts/app/api/hello/route.ts +1 -1
- package/templates/next/c3.ts +36 -18
- package/templates/next/pages/js/pages/api/hello.js +1 -1
- package/templates/next/pages/ts/pages/api/hello.ts +1 -1
- package/templates/next/wrangler.toml +33 -5
- package/templates/nuxt/c3.ts +13 -13
- package/templates/nuxt/templates/worker-configuration.d.ts +1 -1
- package/templates/nuxt/templates/wrangler.toml +35 -2
- package/templates/openapi/c3.ts +1 -0
- package/templates/openapi/ts/README.md +3 -3
- package/templates/openapi/ts/package.json +7 -4
- package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
- package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
- package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
- package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
- package/templates/openapi/ts/src/index.ts +14 -20
- package/templates/openapi/ts/src/types.ts +9 -8
- package/templates/openapi/ts/worker-configuration.d.ts +4 -0
- package/templates/openapi/ts/wrangler.toml +110 -0
- package/templates/pre-existing/c3.ts +7 -7
- package/templates/pre-existing/js/package.json +1 -1
- package/templates/pre-existing/js/wrangler.toml +1 -0
- package/templates/queues/c3.ts +2 -0
- package/templates/queues/js/package.json +1 -1
- package/templates/queues/js/wrangler.toml +17 -1
- package/templates/queues/ts/package.json +4 -3
- package/templates/queues/ts/src/index.ts +6 -8
- package/templates/queues/ts/tsconfig.json +1 -1
- package/templates/queues/ts/worker-configuration.d.ts +5 -0
- package/templates/queues/ts/wrangler.toml +17 -1
- package/templates/qwik/c3.ts +10 -9
- package/templates/qwik/templates/worker-configuration.d.ts +1 -1
- package/templates/qwik/templates/wrangler.toml +36 -2
- package/templates/react/c3.ts +33 -3
- package/templates/remix/c3.ts +5 -4
- package/templates/remix/templates/worker-configuration.d.ts +1 -1
- package/templates/remix/templates/wrangler.toml +35 -2
- package/templates/scheduled/c3.ts +2 -0
- package/templates/scheduled/js/package.json +3 -3
- package/templates/scheduled/js/src/index.js +8 -1
- package/templates/scheduled/js/wrangler.toml +18 -2
- package/templates/scheduled/ts/package.json +5 -4
- package/templates/scheduled/ts/src/index.ts +6 -23
- package/templates/scheduled/ts/tsconfig.json +1 -1
- package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
- package/templates/scheduled/ts/wrangler.toml +18 -2
- package/templates/solid/c3.ts +17 -12
- package/templates/solid/templates/wrangler.toml +84 -0
- package/templates/svelte/c3.ts +10 -9
- package/templates/svelte/js/wrangler.toml +35 -2
- package/templates/svelte/ts/wrangler.toml +35 -2
- package/templates/vue/c3.ts +1 -0
- package/templates-experimental/angular/c3.ts +98 -0
- package/templates-experimental/angular/templates/server.ts +34 -0
- package/templates-experimental/angular/templates/tools/alter-polyfills.mjs +32 -0
- package/templates-experimental/angular/templates/wrangler.toml +11 -0
- package/templates-experimental/astro/c3.ts +114 -0
- package/templates-experimental/astro/snippets/runtimeDeclaration.ts +5 -0
- package/templates-experimental/astro/templates/public/.assetsignore +4 -0
- package/templates-experimental/astro/templates/wrangler.toml +12 -0
- package/templates-experimental/docusaurus/c3.ts +32 -0
- package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
- package/templates-experimental/gatsby/c3.ts +53 -0
- package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
- package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
- package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
- package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
- package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
- package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
- package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +101 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
- package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
- package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
- package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
- package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
- package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
- package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
- package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
- package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
- package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
- package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
- package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
- package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
- package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
- package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
- package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
- package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
- package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
- package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
- package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
- package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
- package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
- package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +103 -0
- package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
- package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
- package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
- package/templates-experimental/hono/c3.ts +43 -0
- package/templates-experimental/hono/templates/public/index.html +19 -0
- package/templates-experimental/hono/templates/src/index.ts +9 -0
- package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/hono/templates/wrangler.toml +5 -0
- package/templates-experimental/nuxt/c3.ts +135 -0
- package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts +27 -0
- package/templates-experimental/nuxt/templates/env.d.ts +14 -0
- package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
- package/templates-experimental/qwik/c3.ts +153 -0
- package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
- package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
- package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/qwik/templates/wrangler.toml +12 -0
- package/templates-experimental/remix/c3.ts +77 -0
- package/templates-experimental/remix/templates/public/.assetsignore +4 -0
- package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
- package/templates-experimental/remix/templates/wrangler.toml +11 -0
- package/templates-experimental/solid/c3.ts +137 -0
- package/templates-experimental/solid/templates/wrangler.toml +12 -0
- package/templates-experimental/svelte/c3.ts +132 -0
- package/templates-experimental/svelte/js/static/.assetsignore +4 -0
- package/templates-experimental/svelte/js/wrangler.toml +11 -0
- package/templates-experimental/svelte/ts/static/.assetsignore +4 -0
- package/templates-experimental/svelte/ts/wrangler.toml +11 -0
- package/templates/hello-world/ts/vitest.config.ts +0 -11
package/templates/hono/c3.ts
CHANGED
|
@@ -1,24 +1,68 @@
|
|
|
1
1
|
import { logRaw } from "@cloudflare/cli";
|
|
2
|
+
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
3
|
+
import { spinner } from "@cloudflare/cli/interactive";
|
|
2
4
|
import { runFrameworkGenerator } from "frameworks/index";
|
|
5
|
+
import { loadTemplateSnippets, transformFile } from "helpers/codemod";
|
|
6
|
+
import { detectPackageManager } from "helpers/packageManagers";
|
|
3
7
|
import type { TemplateConfig } from "../../src/templates";
|
|
8
|
+
import type * as recast from "recast";
|
|
4
9
|
import type { C3Context } from "types";
|
|
5
10
|
|
|
6
11
|
const generate = async (ctx: C3Context) => {
|
|
12
|
+
const { name: pm } = detectPackageManager();
|
|
13
|
+
|
|
7
14
|
await runFrameworkGenerator(ctx, [
|
|
8
15
|
ctx.project.name,
|
|
9
16
|
"--template",
|
|
10
17
|
"cloudflare-workers",
|
|
18
|
+
"--install",
|
|
19
|
+
"--pm",
|
|
20
|
+
pm,
|
|
11
21
|
]);
|
|
12
22
|
|
|
13
23
|
logRaw(""); // newline
|
|
14
24
|
};
|
|
15
25
|
|
|
26
|
+
const configure = async (ctx: C3Context) => {
|
|
27
|
+
const indexFile = "src/index.ts";
|
|
28
|
+
|
|
29
|
+
const s = spinner();
|
|
30
|
+
s.start(`Updating \`${indexFile}\``);
|
|
31
|
+
|
|
32
|
+
const snippets = loadTemplateSnippets(ctx);
|
|
33
|
+
|
|
34
|
+
transformFile(indexFile, {
|
|
35
|
+
visitVariableDeclarator(n) {
|
|
36
|
+
if (n.node.id.type === "Identifier" && n.node.id.name === "app") {
|
|
37
|
+
n.node.init = snippets
|
|
38
|
+
.appDeclarationTs[0] as recast.types.namedTypes.NewExpression;
|
|
39
|
+
|
|
40
|
+
return false;
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
s.stop(`${brandColor("updated")} \`${dim(indexFile)}\``);
|
|
46
|
+
};
|
|
47
|
+
|
|
16
48
|
const config: TemplateConfig = {
|
|
17
49
|
configVersion: 1,
|
|
18
50
|
id: "hono",
|
|
51
|
+
frameworkCli: "create-hono",
|
|
19
52
|
displayName: "Hono",
|
|
53
|
+
copyFiles: {
|
|
54
|
+
path: "./templates",
|
|
55
|
+
},
|
|
20
56
|
platform: "workers",
|
|
21
57
|
generate,
|
|
58
|
+
configure,
|
|
59
|
+
transformPackageJson: async () => ({
|
|
60
|
+
scripts: {
|
|
61
|
+
dev: "wrangler dev",
|
|
62
|
+
deploy: "wrangler deploy --minify",
|
|
63
|
+
"cf-typegen": "wrangler types --env-interface CloudflareBindings",
|
|
64
|
+
},
|
|
65
|
+
}),
|
|
22
66
|
devScript: "dev",
|
|
23
67
|
deployScript: "deploy",
|
|
24
68
|
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
new Hono<{ Bindings: CloudflareBindings }>()
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
2
|
+
name = "<TBD>"
|
|
3
|
+
main = "src/index.ts"
|
|
4
|
+
compatibility_date = "<TBD>"
|
|
5
|
+
|
|
6
|
+
# Workers Logs
|
|
7
|
+
# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
|
|
8
|
+
# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
|
|
9
|
+
[observability]
|
|
10
|
+
enabled = true
|
|
11
|
+
|
|
12
|
+
# Automatically place your workloads in an optimal location to minimize latency.
|
|
13
|
+
# If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
|
|
14
|
+
# rather than the end user may result in better performance.
|
|
15
|
+
# Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
|
|
16
|
+
# [placement]
|
|
17
|
+
# mode = "smart"
|
|
18
|
+
|
|
19
|
+
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
20
|
+
# Docs:
|
|
21
|
+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
|
|
22
|
+
# Note: Use secrets to store sensitive data.
|
|
23
|
+
# - https://developers.cloudflare.com/workers/configuration/secrets/
|
|
24
|
+
# [vars]
|
|
25
|
+
# MY_VARIABLE = "production_value"
|
|
26
|
+
|
|
27
|
+
# Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
|
|
28
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
|
|
29
|
+
# [ai]
|
|
30
|
+
# binding = "AI"
|
|
31
|
+
|
|
32
|
+
# Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
|
|
33
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
|
|
34
|
+
# [[analytics_engine_datasets]]
|
|
35
|
+
# binding = "MY_DATASET"
|
|
36
|
+
|
|
37
|
+
# Bind a headless browser instance running on Cloudflare's global network.
|
|
38
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
|
|
39
|
+
# [browser]
|
|
40
|
+
# binding = "MY_BROWSER"
|
|
41
|
+
|
|
42
|
+
# Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
|
|
43
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
|
|
44
|
+
# [[d1_databases]]
|
|
45
|
+
# binding = "MY_DB"
|
|
46
|
+
# database_name = "my-database"
|
|
47
|
+
# database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
48
|
+
|
|
49
|
+
# Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
|
|
50
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
|
|
51
|
+
# [[dispatch_namespaces]]
|
|
52
|
+
# binding = "MY_DISPATCHER"
|
|
53
|
+
# namespace = "my-namespace"
|
|
54
|
+
|
|
55
|
+
# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
|
|
56
|
+
# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
|
|
57
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
|
|
58
|
+
# [[durable_objects.bindings]]
|
|
59
|
+
# name = "MY_DURABLE_OBJECT"
|
|
60
|
+
# class_name = "MyDurableObject"
|
|
61
|
+
|
|
62
|
+
# Durable Object migrations.
|
|
63
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
|
|
64
|
+
# [[migrations]]
|
|
65
|
+
# tag = "v1"
|
|
66
|
+
# new_classes = ["MyDurableObject"]
|
|
67
|
+
|
|
68
|
+
# Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
|
|
69
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
|
|
70
|
+
# [[hyperdrive]]
|
|
71
|
+
# binding = "MY_HYPERDRIVE"
|
|
72
|
+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
73
|
+
|
|
74
|
+
# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
|
|
75
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
|
|
76
|
+
# [[kv_namespaces]]
|
|
77
|
+
# binding = "MY_KV_NAMESPACE"
|
|
78
|
+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
|
|
79
|
+
|
|
80
|
+
# Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
|
|
81
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
|
|
82
|
+
# [[mtls_certificates]]
|
|
83
|
+
# binding = "MY_CERTIFICATE"
|
|
84
|
+
# certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
85
|
+
|
|
86
|
+
# Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
|
|
87
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
|
|
88
|
+
# [[queues.producers]]
|
|
89
|
+
# binding = "MY_QUEUE"
|
|
90
|
+
# queue = "my-queue"
|
|
91
|
+
|
|
92
|
+
# Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
|
|
93
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
|
|
94
|
+
# [[queues.consumers]]
|
|
95
|
+
# queue = "my-queue"
|
|
96
|
+
|
|
97
|
+
# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
|
|
98
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
|
|
99
|
+
# [[r2_buckets]]
|
|
100
|
+
# binding = "MY_BUCKET"
|
|
101
|
+
# bucket_name = "my-bucket"
|
|
102
|
+
|
|
103
|
+
# Bind another Worker service. Use this binding to call another Worker without network overhead.
|
|
104
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
|
|
105
|
+
# [[services]]
|
|
106
|
+
# binding = "MY_SERVICE"
|
|
107
|
+
# service = "my-service"
|
|
108
|
+
|
|
109
|
+
# Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
|
|
110
|
+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
|
|
111
|
+
# [[vectorize]]
|
|
112
|
+
# binding = "MY_INDEX"
|
|
113
|
+
# index_name = "my-index"
|
package/templates/next/README.md
CHANGED
|
@@ -23,7 +23,7 @@ Besides the `dev` script mentioned above `c3` has added a few extra scripts that
|
|
|
23
23
|
- `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
|
|
24
24
|
- `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
|
|
25
25
|
|
|
26
|
-
> __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/
|
|
26
|
+
> __Note:__ while the `dev` script is optimal for local development you should preview your Pages application as well (periodically or before deployments) in order to make sure that it can properly work in the Pages environment (for more details see the [`@cloudflare/next-on-pages` recommended workflow](https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md#recommended-development-workflow))
|
|
27
27
|
|
|
28
28
|
### Bindings
|
|
29
29
|
|
|
@@ -52,17 +52,17 @@ In order to enable the example:
|
|
|
52
52
|
```
|
|
53
53
|
# KV Example:
|
|
54
54
|
```
|
|
55
|
-
- If you're using TypeScript run the `
|
|
55
|
+
- If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
|
|
56
56
|
```bash
|
|
57
|
-
npm run
|
|
57
|
+
npm run cf-typegen
|
|
58
58
|
# or
|
|
59
|
-
yarn
|
|
59
|
+
yarn cf-typegen
|
|
60
60
|
# or
|
|
61
|
-
pnpm
|
|
61
|
+
pnpm cf-typegen
|
|
62
62
|
# or
|
|
63
|
-
bun
|
|
63
|
+
bun cf-typegen
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
After doing this you can run the `dev` or `preview` script and visit the `/api/hello` route to see the example in action.
|
|
67
67
|
|
|
68
|
-
Finally, if you also want to see the example work in the deployed application make sure to add a `
|
|
68
|
+
Finally, if you also want to see the example work in the deployed application make sure to add a `MY_KV_NAMESPACE` binding to your Pages application in its [dashboard kv bindings settings section](https://dash.cloudflare.com/?to=/:account/pages/view/:pages-project/settings/functions#kv_namespace_bindings_section). After having configured it make sure to re-deploy your application.
|
|
@@ -12,7 +12,7 @@ export async function GET(request) {
|
|
|
12
12
|
// )
|
|
13
13
|
//
|
|
14
14
|
// KV Example:
|
|
15
|
-
// const myKv = getRequestContext().env.
|
|
15
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
16
16
|
// await myKv.put('suffix', ' from a KV store!')
|
|
17
17
|
// const suffix = await myKv.get('suffix')
|
|
18
18
|
// responseText += suffix
|
|
@@ -13,7 +13,7 @@ export async function GET(request: NextRequest) {
|
|
|
13
13
|
// )
|
|
14
14
|
//
|
|
15
15
|
// KV Example:
|
|
16
|
-
// const myKv = getRequestContext().env.
|
|
16
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
17
17
|
// await myKv.put('suffix', ' from a KV store!')
|
|
18
18
|
// const suffix = await myKv.get('suffix')
|
|
19
19
|
// responseText += suffix
|
package/templates/next/c3.ts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { join } from "path";
|
|
2
|
-
import {
|
|
3
|
-
import { processArgument } from "@cloudflare/cli/args";
|
|
2
|
+
import { updateStatus, warn } from "@cloudflare/cli";
|
|
4
3
|
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
5
|
-
import { spinner } from "@cloudflare/cli/interactive";
|
|
4
|
+
import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
|
|
6
5
|
import { runFrameworkGenerator } from "frameworks/index";
|
|
7
6
|
import {
|
|
8
7
|
copyFile,
|
|
@@ -18,7 +17,7 @@ import { detectPackageManager } from "helpers/packageManagers";
|
|
|
18
17
|
import { installPackages } from "helpers/packages";
|
|
19
18
|
import { getTemplatePath } from "../../src/templates";
|
|
20
19
|
import type { TemplateConfig } from "../../src/templates";
|
|
21
|
-
import type {
|
|
20
|
+
import type { C3Context } from "types";
|
|
22
21
|
|
|
23
22
|
const { npm, npx } = detectPackageManager();
|
|
24
23
|
|
|
@@ -27,10 +26,26 @@ const generate = async (ctx: C3Context) => {
|
|
|
27
26
|
|
|
28
27
|
await runFrameworkGenerator(ctx, [projectName]);
|
|
29
28
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
29
|
+
const wranglerToml = readFile(join(getTemplatePath(ctx), "wrangler.toml"));
|
|
30
|
+
|
|
31
|
+
// Note: here we add `# KV Example:` to the toml file for the KV example, we don't actually
|
|
32
|
+
// include the comment in the template wrangler.toml file just so to keep it identical
|
|
33
|
+
// and consistent with that of all the other frameworks
|
|
34
|
+
// (instead of making it a special case which needs extra care)
|
|
35
|
+
const newTomlContent = wranglerToml.replace(
|
|
36
|
+
/#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
|
|
37
|
+
($1) => `# KV Example:\n${$1}`,
|
|
33
38
|
);
|
|
39
|
+
|
|
40
|
+
if (!/# KV Example/.test(newTomlContent)) {
|
|
41
|
+
// This should never happen to users, it is a check mostly so that
|
|
42
|
+
// if the toml file is changed in a way that breaks the "KV Example" addition
|
|
43
|
+
// the C3 Next.js e2e runs will fail with this
|
|
44
|
+
throw new Error("Failed to properly generate the wrangler.toml file");
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
|
|
48
|
+
|
|
34
49
|
updateStatus("Created wrangler.toml file");
|
|
35
50
|
};
|
|
36
51
|
|
|
@@ -47,7 +62,7 @@ const updateNextConfig = () => {
|
|
|
47
62
|
|
|
48
63
|
// Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
|
|
49
64
|
// (when running the application with \`next dev\`), for more information see:
|
|
50
|
-
// https://github.com/cloudflare/next-on-pages/blob/
|
|
65
|
+
// https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
|
|
51
66
|
if (process.env.NODE_ENV === 'development') {
|
|
52
67
|
await setupDevPlatform();
|
|
53
68
|
}
|
|
@@ -73,7 +88,7 @@ const configure = async (ctx: C3Context) => {
|
|
|
73
88
|
]);
|
|
74
89
|
|
|
75
90
|
if (!path) {
|
|
76
|
-
|
|
91
|
+
throw new Error("Could not find the `/api` or `/app` directory");
|
|
77
92
|
}
|
|
78
93
|
|
|
79
94
|
const usesTs = usesTypescript(ctx);
|
|
@@ -81,7 +96,7 @@ const configure = async (ctx: C3Context) => {
|
|
|
81
96
|
if (usesTs) {
|
|
82
97
|
copyFile(
|
|
83
98
|
join(getTemplatePath(ctx), "env.d.ts"),
|
|
84
|
-
join(projectPath, "env.d.ts")
|
|
99
|
+
join(projectPath, "env.d.ts"),
|
|
85
100
|
);
|
|
86
101
|
updateStatus("Created an env.d.ts file");
|
|
87
102
|
}
|
|
@@ -96,7 +111,7 @@ const configure = async (ctx: C3Context) => {
|
|
|
96
111
|
|
|
97
112
|
copyFile(
|
|
98
113
|
join(getTemplatePath(ctx), "README.md"),
|
|
99
|
-
join(projectPath, "README.md")
|
|
114
|
+
join(projectPath, "README.md"),
|
|
100
115
|
);
|
|
101
116
|
updateStatus("Updated the README file");
|
|
102
117
|
|
|
@@ -104,20 +119,22 @@ const configure = async (ctx: C3Context) => {
|
|
|
104
119
|
};
|
|
105
120
|
|
|
106
121
|
export const shouldInstallNextOnPagesEslintPlugin = async (
|
|
107
|
-
ctx: C3Context
|
|
122
|
+
ctx: C3Context,
|
|
108
123
|
): Promise<boolean> => {
|
|
109
124
|
const eslintUsage = usesEslint(ctx);
|
|
110
125
|
|
|
111
|
-
if (!eslintUsage.used)
|
|
126
|
+
if (!eslintUsage.used) {
|
|
127
|
+
return false;
|
|
128
|
+
}
|
|
112
129
|
|
|
113
130
|
if (eslintUsage.configType !== ".eslintrc.json") {
|
|
114
131
|
warn(
|
|
115
|
-
`Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead
|
|
132
|
+
`Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
|
|
116
133
|
);
|
|
117
134
|
return false;
|
|
118
135
|
}
|
|
119
136
|
|
|
120
|
-
return await
|
|
137
|
+
return await inputPrompt({
|
|
121
138
|
type: "confirm",
|
|
122
139
|
question: "Do you want to use the next-on-pages eslint-plugin?",
|
|
123
140
|
label: "eslint-plugin",
|
|
@@ -157,6 +174,7 @@ const addDevDependencies = async (installEslintPlugin: boolean) => {
|
|
|
157
174
|
export default {
|
|
158
175
|
configVersion: 1,
|
|
159
176
|
id: "next",
|
|
177
|
+
frameworkCli: "create-next-app",
|
|
160
178
|
platform: "pages",
|
|
161
179
|
displayName: "Next",
|
|
162
180
|
generate,
|
|
@@ -205,10 +223,10 @@ export default {
|
|
|
205
223
|
return {
|
|
206
224
|
scripts: {
|
|
207
225
|
"pages:build": `${pmCommand} ${nextOnPagesCommand}`,
|
|
208
|
-
preview: `${pagesBuildRunCommand} && wrangler pages dev
|
|
209
|
-
deploy: `${pagesBuildRunCommand} && wrangler pages deploy
|
|
226
|
+
preview: `${pagesBuildRunCommand} && wrangler pages dev`,
|
|
227
|
+
deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
|
|
210
228
|
...(usesTypescript(ctx) && {
|
|
211
|
-
"
|
|
229
|
+
"cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
|
|
212
230
|
}),
|
|
213
231
|
},
|
|
214
232
|
};
|
|
@@ -14,7 +14,7 @@ export default async function handler(req) {
|
|
|
14
14
|
// )
|
|
15
15
|
//
|
|
16
16
|
// KV Example:
|
|
17
|
-
// const myKv = getRequestContext().env.
|
|
17
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
18
18
|
// await myKv.put('suffix', ' from a KV store!')
|
|
19
19
|
// const suffix = await myKv.get('suffix')
|
|
20
20
|
// responseText += suffix
|
|
@@ -15,7 +15,7 @@ export default async function handler(req: NextRequest) {
|
|
|
15
15
|
// )
|
|
16
16
|
//
|
|
17
17
|
// KV Example:
|
|
18
|
-
// const myKv = getRequestContext().env.
|
|
18
|
+
// const myKv = getRequestContext().env.MY_KV_NAMESPACE
|
|
19
19
|
// await myKv.put('suffix', ' from a KV store!')
|
|
20
20
|
// const suffix = await myKv.get('suffix')
|
|
21
21
|
// responseText += suffix
|
|
@@ -1,10 +1,21 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
1
2
|
name = "<TBD>"
|
|
2
3
|
compatibility_date = "<TBD>"
|
|
3
4
|
compatibility_flags = ["nodejs_compat"]
|
|
5
|
+
pages_build_output_dir = ".vercel/output/static"
|
|
6
|
+
|
|
7
|
+
# Automatically place your workloads in an optimal location to minimize latency.
|
|
8
|
+
# If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
|
|
9
|
+
# rather than the end user may result in better performance.
|
|
10
|
+
# Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
|
|
11
|
+
# [placement]
|
|
12
|
+
# mode = "smart"
|
|
4
13
|
|
|
5
14
|
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
15
|
+
# Docs:
|
|
16
|
+
# - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
|
|
6
17
|
# Note: Use secrets to store sensitive data.
|
|
7
|
-
#
|
|
18
|
+
# - https://developers.cloudflare.com/pages/functions/bindings/#secrets
|
|
8
19
|
# [vars]
|
|
9
20
|
# MY_VARIABLE = "production_value"
|
|
10
21
|
|
|
@@ -52,7 +63,24 @@ compatibility_flags = ["nodejs_compat"]
|
|
|
52
63
|
# binding = "MY_SERVICE"
|
|
53
64
|
# service = "my-service"
|
|
54
65
|
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
|
|
66
|
+
# To use different bindings for preview and production environments, follow the examples below.
|
|
67
|
+
# When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
|
|
68
|
+
# Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
|
|
69
|
+
|
|
70
|
+
######## PREVIEW environment config ########
|
|
71
|
+
|
|
72
|
+
# [env.preview.vars]
|
|
73
|
+
# API_KEY = "xyz789"
|
|
74
|
+
|
|
75
|
+
# [[env.preview.kv_namespaces]]
|
|
76
|
+
# binding = "MY_KV_NAMESPACE"
|
|
77
|
+
# id = "<PREVIEW_NAMESPACE_ID>"
|
|
78
|
+
|
|
79
|
+
######## PRODUCTION environment config ########
|
|
80
|
+
|
|
81
|
+
# [env.production.vars]
|
|
82
|
+
# API_KEY = "abc123"
|
|
83
|
+
|
|
84
|
+
# [[env.production.kv_namespaces]]
|
|
85
|
+
# binding = "MY_KV_NAMESPACE"
|
|
86
|
+
# id = "<PRODUCTION_NAMESPACE_ID>"
|
package/templates/nuxt/c3.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { logRaw } from "@cloudflare/cli";
|
|
|
2
2
|
import { brandColor, dim } from "@cloudflare/cli/colors";
|
|
3
3
|
import { spinner } from "@cloudflare/cli/interactive";
|
|
4
4
|
import { runFrameworkGenerator } from "frameworks/index";
|
|
5
|
-
import { transformFile } from "helpers/codemod";
|
|
5
|
+
import { mergeObjectProperties, transformFile } from "helpers/codemod";
|
|
6
6
|
import { getLatestTypesEntrypoint } from "helpers/compatDate";
|
|
7
7
|
import { readFile, writeFile } from "helpers/files";
|
|
8
8
|
import { detectPackageManager } from "helpers/packageManagers";
|
|
@@ -56,7 +56,7 @@ const updateEnvTypes = (ctx: C3Context) => {
|
|
|
56
56
|
|
|
57
57
|
let file = readFile(filepath);
|
|
58
58
|
|
|
59
|
-
let typesEntrypoint = `@cloudflare/workers-types
|
|
59
|
+
let typesEntrypoint = `@cloudflare/workers-types`;
|
|
60
60
|
const latestEntrypoint = getLatestTypesEntrypoint(ctx);
|
|
61
61
|
if (latestEntrypoint) {
|
|
62
62
|
typesEntrypoint += `/${latestEntrypoint}`;
|
|
@@ -82,25 +82,24 @@ const updateNuxtConfig = () => {
|
|
|
82
82
|
b.objectExpression([
|
|
83
83
|
b.objectProperty(
|
|
84
84
|
b.identifier("preset"),
|
|
85
|
-
b.stringLiteral("cloudflare-pages")
|
|
85
|
+
b.stringLiteral("cloudflare-pages"),
|
|
86
86
|
),
|
|
87
|
-
])
|
|
87
|
+
]),
|
|
88
88
|
);
|
|
89
89
|
|
|
90
90
|
const moduleDef = b.objectProperty(
|
|
91
91
|
b.identifier("modules"),
|
|
92
|
-
b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
|
|
92
|
+
b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
|
|
93
93
|
);
|
|
94
94
|
|
|
95
95
|
transformFile(configFile, {
|
|
96
96
|
visitCallExpression: function (n) {
|
|
97
97
|
const callee = n.node.callee as recast.types.namedTypes.Identifier;
|
|
98
98
|
if (callee.name === "defineNuxtConfig") {
|
|
99
|
-
|
|
100
|
-
.arguments[0] as recast.types.namedTypes.ObjectExpression
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
obj.properties.push(moduleDef);
|
|
99
|
+
mergeObjectProperties(
|
|
100
|
+
n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
|
|
101
|
+
[presetDef, moduleDef],
|
|
102
|
+
);
|
|
104
103
|
}
|
|
105
104
|
|
|
106
105
|
return this.traverse(n);
|
|
@@ -113,6 +112,7 @@ const updateNuxtConfig = () => {
|
|
|
113
112
|
const config: TemplateConfig = {
|
|
114
113
|
configVersion: 1,
|
|
115
114
|
id: "nuxt",
|
|
115
|
+
frameworkCli: "nuxi",
|
|
116
116
|
platform: "pages",
|
|
117
117
|
displayName: "Nuxt",
|
|
118
118
|
copyFiles: {
|
|
@@ -122,9 +122,9 @@ const config: TemplateConfig = {
|
|
|
122
122
|
configure,
|
|
123
123
|
transformPackageJson: async () => ({
|
|
124
124
|
scripts: {
|
|
125
|
-
deploy: `${npm} run build && wrangler pages deploy
|
|
126
|
-
preview: `${npm} run build && wrangler pages dev
|
|
127
|
-
"
|
|
125
|
+
deploy: `${npm} run build && wrangler pages deploy`,
|
|
126
|
+
preview: `${npm} run build && wrangler pages dev`,
|
|
127
|
+
"cf-typegen": `wrangler types`,
|
|
128
128
|
},
|
|
129
129
|
}),
|
|
130
130
|
devScript: "dev",
|
|
@@ -1,9 +1,20 @@
|
|
|
1
|
+
#:schema node_modules/wrangler/config-schema.json
|
|
1
2
|
name = "<TBD>"
|
|
2
3
|
compatibility_date = "<TBD>"
|
|
4
|
+
pages_build_output_dir = "./dist"
|
|
5
|
+
|
|
6
|
+
# Automatically place your workloads in an optimal location to minimize latency.
|
|
7
|
+
# If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
|
|
8
|
+
# rather than the end user may result in better performance.
|
|
9
|
+
# Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
|
|
10
|
+
# [placement]
|
|
11
|
+
# mode = "smart"
|
|
3
12
|
|
|
4
13
|
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
|
|
14
|
+
# Docs:
|
|
15
|
+
# - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
|
|
5
16
|
# Note: Use secrets to store sensitive data.
|
|
6
|
-
#
|
|
17
|
+
# - https://developers.cloudflare.com/pages/functions/bindings/#secrets
|
|
7
18
|
# [vars]
|
|
8
19
|
# MY_VARIABLE = "production_value"
|
|
9
20
|
|
|
@@ -49,4 +60,26 @@ compatibility_date = "<TBD>"
|
|
|
49
60
|
# Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
|
|
50
61
|
# [[services]]
|
|
51
62
|
# binding = "MY_SERVICE"
|
|
52
|
-
# service = "my-service"
|
|
63
|
+
# service = "my-service"
|
|
64
|
+
|
|
65
|
+
# To use different bindings for preview and production environments, follow the examples below.
|
|
66
|
+
# When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
|
|
67
|
+
# Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
|
|
68
|
+
|
|
69
|
+
######## PREVIEW environment config ########
|
|
70
|
+
|
|
71
|
+
# [env.preview.vars]
|
|
72
|
+
# API_KEY = "xyz789"
|
|
73
|
+
|
|
74
|
+
# [[env.preview.kv_namespaces]]
|
|
75
|
+
# binding = "MY_KV_NAMESPACE"
|
|
76
|
+
# id = "<PREVIEW_NAMESPACE_ID>"
|
|
77
|
+
|
|
78
|
+
######## PRODUCTION environment config ########
|
|
79
|
+
|
|
80
|
+
# [env.production.vars]
|
|
81
|
+
# API_KEY = "abc123"
|
|
82
|
+
|
|
83
|
+
# [[env.production.kv_namespaces]]
|
|
84
|
+
# binding = "MY_KV_NAMESPACE"
|
|
85
|
+
# id = "<PRODUCTION_NAMESPACE_ID>"
|
package/templates/openapi/c3.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Cloudflare Workers OpenAPI 3.1
|
|
2
2
|
|
|
3
|
-
This is a Cloudflare Worker with OpenAPI 3.1 using [
|
|
3
|
+
This is a Cloudflare Worker with OpenAPI 3.1 using [chanfana](https://github.com/cloudflare/chanfana) and [Hono](https://github.com/honojs/hono).
|
|
4
4
|
|
|
5
5
|
This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
|
|
6
6
|
`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
|
|
@@ -16,10 +16,10 @@ This is an example project made to be used as a quick start into building OpenAP
|
|
|
16
16
|
|
|
17
17
|
1. Your main router is defined in `src/index.ts`.
|
|
18
18
|
2. Each endpoint has its own file in `src/endpoints/`.
|
|
19
|
-
3. For more information read the [
|
|
19
|
+
3. For more information read the [chanfana documentation](https://chanfana.pages.dev/) and [Hono documentation](https://hono.dev/docs).
|
|
20
20
|
|
|
21
21
|
## Development
|
|
22
22
|
|
|
23
23
|
1. Run `wrangler dev` to start a local instance of the API.
|
|
24
|
-
2. Open `http://localhost:
|
|
24
|
+
2. Open `http://localhost:8787/` in your browser to see the Swagger interface where you can try the endpoints.
|
|
25
25
|
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
|
|
@@ -5,14 +5,17 @@
|
|
|
5
5
|
"scripts": {
|
|
6
6
|
"deploy": "wrangler deploy",
|
|
7
7
|
"dev": "wrangler dev",
|
|
8
|
-
"start": "wrangler dev"
|
|
8
|
+
"start": "wrangler dev",
|
|
9
|
+
"cf-typegen": "wrangler types"
|
|
9
10
|
},
|
|
10
11
|
"dependencies": {
|
|
11
|
-
"
|
|
12
|
+
"chanfana": "^2.0.2",
|
|
13
|
+
"zod": "^3.23.8",
|
|
14
|
+
"hono": "^4.4.7"
|
|
12
15
|
},
|
|
13
16
|
"devDependencies": {
|
|
14
|
-
"@types/node": "
|
|
17
|
+
"@types/node": "20.8.3",
|
|
15
18
|
"@types/service-worker-mock": "^2.0.1",
|
|
16
|
-
"wrangler": "^3.
|
|
19
|
+
"wrangler": "^3.60.3"
|
|
17
20
|
}
|
|
18
21
|
}
|