create-cloudflare 0.0.0-e4aff81a → 0.0.0-e4c79bba8

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 (240) hide show
  1. package/README.md +2 -53
  2. package/dist/cli.js +76058 -56978
  3. package/dist/tsconfig.tsbuildinfo +1 -0
  4. package/package.json +41 -27
  5. package/templates/analog/c3.ts +135 -0
  6. package/templates/analog/snippets/devBindingsModule.ts +7 -0
  7. package/templates/analog/templates/env.d.ts +13 -0
  8. package/templates/analog/templates/src/dev-bindings.ts +18 -0
  9. package/templates/analog/templates/worker-configuration.d.ts +4 -0
  10. package/templates/analog/templates/wrangler.toml +85 -0
  11. package/templates/angular/c3.ts +114 -0
  12. package/templates/angular/templates/src/server.ts +15 -0
  13. package/templates/angular/templates/tools/copy-files.mjs +15 -0
  14. package/templates/astro/c3.ts +97 -0
  15. package/templates/astro/templates/js/wrangler.toml +86 -0
  16. package/templates/astro/templates/ts/src/env.d.ts +5 -0
  17. package/templates/astro/templates/ts/worker-configuration.d.ts +4 -0
  18. package/templates/astro/templates/ts/wrangler.toml +86 -0
  19. package/templates/common/c3.ts +19 -0
  20. package/templates/common/js/.editorconfig +0 -1
  21. package/templates/common/js/package.json +1 -1
  22. package/templates/common/js/wrangler.toml +84 -22
  23. package/templates/common/ts/.editorconfig +0 -1
  24. package/templates/common/ts/package.json +4 -4
  25. package/templates/common/ts/src/ab-test.ts +2 -2
  26. package/templates/common/ts/src/index.ts +5 -2
  27. package/templates/common/ts/src/proxy.ts +2 -2
  28. package/templates/common/ts/src/redirect.ts +2 -2
  29. package/templates/common/ts/tsconfig.json +37 -95
  30. package/templates/common/ts/worker-configuration.d.ts +2 -14
  31. package/templates/common/ts/wrangler.toml +84 -22
  32. package/templates/docusaurus/c3.ts +28 -0
  33. package/templates/gatsby/c3.ts +49 -0
  34. package/templates/hello-world/c3.ts +20 -0
  35. package/templates/hello-world/js/.editorconfig +0 -1
  36. package/templates/hello-world/js/package.json +5 -2
  37. package/templates/hello-world/js/test/index.spec.js +20 -0
  38. package/templates/hello-world/js/vitest.config.js +11 -0
  39. package/templates/hello-world/js/wrangler.toml +85 -22
  40. package/templates/hello-world/py/__dot__gitignore +68 -0
  41. package/templates/hello-world/py/package.json +13 -0
  42. package/templates/hello-world/py/src/entry.py +4 -0
  43. package/templates/hello-world/py/wrangler.toml +114 -0
  44. package/templates/hello-world/ts/.editorconfig +0 -1
  45. package/templates/hello-world/ts/package.json +7 -4
  46. package/templates/hello-world/ts/src/index.ts +5 -19
  47. package/templates/hello-world/ts/test/index.spec.ts +25 -0
  48. package/templates/hello-world/ts/test/tsconfig.json +8 -0
  49. package/templates/hello-world/ts/tsconfig.json +39 -96
  50. package/templates/hello-world/ts/vitest.config.mts +11 -0
  51. package/templates/hello-world/ts/worker-configuration.d.ts +4 -0
  52. package/templates/hello-world/ts/wrangler.toml +85 -22
  53. package/templates/hello-world-durable-object/c3.ts +18 -0
  54. package/templates/hello-world-durable-object/js/.editorconfig +12 -0
  55. package/templates/hello-world-durable-object/js/.prettierrc +6 -0
  56. package/templates/hello-world-durable-object/js/__dot__gitignore +172 -0
  57. package/templates/hello-world-durable-object/js/package.json +13 -0
  58. package/templates/hello-world-durable-object/js/src/index.js +69 -0
  59. package/templates/hello-world-durable-object/js/wrangler.toml +113 -0
  60. package/templates/hello-world-durable-object/ts/.editorconfig +12 -0
  61. package/templates/hello-world-durable-object/ts/.prettierrc +6 -0
  62. package/templates/hello-world-durable-object/ts/__dot__gitignore +172 -0
  63. package/templates/hello-world-durable-object/ts/package.json +15 -0
  64. package/templates/hello-world-durable-object/ts/src/index.ts +65 -0
  65. package/templates/hello-world-durable-object/ts/tsconfig.json +42 -0
  66. package/templates/hello-world-durable-object/ts/worker-configuration.d.ts +5 -0
  67. package/templates/hello-world-durable-object/ts/wrangler.toml +113 -0
  68. package/templates/hono/c3.ts +69 -0
  69. package/templates/hono/snippets/appDeclaration.ts +1 -0
  70. package/templates/hono/templates/worker-configuration.d.ts +4 -0
  71. package/templates/hono/templates/wrangler.toml +113 -0
  72. package/templates/next/README.md +68 -0
  73. package/templates/next/app/js/app/api/hello/route.js +21 -0
  74. package/templates/next/app/js/app/not-found.js +58 -0
  75. package/templates/next/app/ts/app/api/hello/route.ts +21 -0
  76. package/templates/next/app/ts/app/not-found.tsx +58 -0
  77. package/templates/next/c3.ts +238 -0
  78. package/templates/next/env.d.ts +5 -0
  79. package/templates/next/pages/js/pages/api/hello.js +23 -0
  80. package/templates/next/pages/ts/pages/api/hello.ts +24 -0
  81. package/templates/next/wrangler.toml +86 -0
  82. package/templates/nuxt/c3.ts +134 -0
  83. package/templates/nuxt/templates/env.d.ts +14 -0
  84. package/templates/nuxt/templates/worker-configuration.d.ts +4 -0
  85. package/templates/nuxt/templates/wrangler.toml +86 -0
  86. package/templates/openapi/c3.ts +10 -0
  87. package/templates/openapi/ts/README.md +3 -3
  88. package/templates/openapi/ts/package.json +7 -5
  89. package/templates/openapi/ts/src/endpoints/taskCreate.ts +26 -16
  90. package/templates/openapi/ts/src/endpoints/taskDelete.ts +20 -19
  91. package/templates/openapi/ts/src/endpoints/taskFetch.ts +30 -23
  92. package/templates/openapi/ts/src/endpoints/taskList.ts +27 -24
  93. package/templates/openapi/ts/src/index.ts +16 -22
  94. package/templates/openapi/ts/src/types.ts +9 -8
  95. package/templates/openapi/ts/worker-configuration.d.ts +4 -0
  96. package/templates/openapi/ts/wrangler.toml +110 -0
  97. package/templates/pre-existing/c3.ts +102 -0
  98. package/templates/pre-existing/js/.editorconfig +12 -0
  99. package/templates/pre-existing/js/.prettierrc +6 -0
  100. package/templates/pre-existing/js/__dot__gitignore +172 -0
  101. package/templates/pre-existing/js/package.json +13 -0
  102. package/templates/pre-existing/js/wrangler.toml +4 -0
  103. package/templates/queues/c3.ts +28 -0
  104. package/templates/queues/js/.editorconfig +0 -1
  105. package/templates/queues/js/package.json +1 -1
  106. package/templates/queues/js/wrangler.toml +101 -2
  107. package/templates/queues/ts/.editorconfig +0 -1
  108. package/templates/queues/ts/package.json +4 -4
  109. package/templates/queues/ts/src/index.ts +6 -8
  110. package/templates/queues/ts/tsconfig.json +36 -95
  111. package/templates/queues/ts/worker-configuration.d.ts +5 -0
  112. package/templates/queues/ts/wrangler.toml +101 -2
  113. package/templates/qwik/c3.ts +147 -0
  114. package/templates/qwik/snippets/getPlatformProxy.ts +6 -0
  115. package/templates/qwik/templates/worker-configuration.d.ts +4 -0
  116. package/templates/qwik/templates/wrangler.toml +86 -0
  117. package/templates/react/c3.ts +61 -0
  118. package/templates/remix/c3.ts +67 -0
  119. package/templates/remix/templates/worker-configuration.d.ts +4 -0
  120. package/templates/remix/templates/wrangler.toml +85 -0
  121. package/templates/scheduled/c3.ts +18 -0
  122. package/templates/scheduled/js/.editorconfig +0 -1
  123. package/templates/scheduled/js/package.json +3 -3
  124. package/templates/scheduled/js/src/index.js +8 -1
  125. package/templates/scheduled/js/wrangler.toml +110 -0
  126. package/templates/scheduled/ts/.editorconfig +0 -1
  127. package/templates/scheduled/ts/package.json +5 -5
  128. package/templates/scheduled/ts/src/index.ts +6 -23
  129. package/templates/scheduled/ts/tsconfig.json +36 -95
  130. package/templates/scheduled/ts/worker-configuration.d.ts +4 -0
  131. package/templates/scheduled/ts/wrangler.toml +110 -0
  132. package/templates/solid/c3.ts +87 -0
  133. package/templates/solid/templates/wrangler.toml +84 -0
  134. package/templates/svelte/c3.ts +158 -0
  135. package/templates/svelte/templates/wrangler.toml +85 -0
  136. package/templates/vue/c3.ts +29 -0
  137. package/templates-experimental/angular/c3.ts +112 -0
  138. package/templates-experimental/angular/templates/src/server.ts +15 -0
  139. package/templates-experimental/angular/templates/wrangler.toml +11 -0
  140. package/templates-experimental/astro/c3.ts +98 -0
  141. package/templates-experimental/astro/templates/js/public/.assetsignore +4 -0
  142. package/templates-experimental/astro/templates/js/wrangler.toml +12 -0
  143. package/templates-experimental/astro/templates/ts/public/.assetsignore +4 -0
  144. package/templates-experimental/astro/templates/ts/src/env.d.ts +5 -0
  145. package/templates-experimental/astro/templates/ts/worker-configuration.d.ts +4 -0
  146. package/templates-experimental/astro/templates/ts/wrangler.toml +12 -0
  147. package/templates-experimental/docusaurus/c3.ts +32 -0
  148. package/templates-experimental/docusaurus/templates/wrangler.toml +10 -0
  149. package/templates-experimental/gatsby/c3.ts +53 -0
  150. package/templates-experimental/gatsby/templates/wrangler.toml +10 -0
  151. package/templates-experimental/hello-world-assets-only/c3.ts +15 -0
  152. package/templates-experimental/hello-world-assets-only/templates/package.json +13 -0
  153. package/templates-experimental/hello-world-assets-only/templates/public/index.html +11 -0
  154. package/templates-experimental/hello-world-assets-only/templates/wrangler.toml +10 -0
  155. package/templates-experimental/hello-world-durable-object-with-assets/c3.ts +23 -0
  156. package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig +12 -0
  157. package/templates-experimental/hello-world-durable-object-with-assets/js/.prettierrc +6 -0
  158. package/{templates/chatgptPlugin/ts → templates-experimental/hello-world-durable-object-with-assets/js}/__dot__gitignore +1 -0
  159. package/templates-experimental/hello-world-durable-object-with-assets/js/package.json +13 -0
  160. package/templates-experimental/hello-world-durable-object-with-assets/js/public/index.html +19 -0
  161. package/templates-experimental/hello-world-durable-object-with-assets/js/src/index.js +69 -0
  162. package/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.toml +24 -0
  163. package/templates-experimental/hello-world-durable-object-with-assets/ts/.editorconfig +12 -0
  164. package/templates-experimental/hello-world-durable-object-with-assets/ts/.prettierrc +6 -0
  165. package/templates-experimental/hello-world-durable-object-with-assets/ts/__dot__gitignore +172 -0
  166. package/templates-experimental/hello-world-durable-object-with-assets/ts/package.json +15 -0
  167. package/templates-experimental/hello-world-durable-object-with-assets/ts/public/index.html +19 -0
  168. package/templates-experimental/hello-world-durable-object-with-assets/ts/src/index.ts +66 -0
  169. package/templates-experimental/hello-world-durable-object-with-assets/ts/tsconfig.json +42 -0
  170. package/templates-experimental/hello-world-durable-object-with-assets/ts/worker-configuration.d.ts +5 -0
  171. package/templates-experimental/hello-world-durable-object-with-assets/ts/wrangler.toml +24 -0
  172. package/templates-experimental/hello-world-with-assets/c3.ts +22 -0
  173. package/templates-experimental/hello-world-with-assets/js/.editorconfig +12 -0
  174. package/templates-experimental/hello-world-with-assets/js/.prettierrc +6 -0
  175. package/templates-experimental/hello-world-with-assets/js/__dot__gitignore +172 -0
  176. package/templates-experimental/hello-world-with-assets/js/package.json +16 -0
  177. package/templates-experimental/hello-world-with-assets/js/public/index.html +31 -0
  178. package/templates-experimental/hello-world-with-assets/js/src/index.js +23 -0
  179. package/templates-experimental/hello-world-with-assets/js/test/index.spec.js +41 -0
  180. package/templates-experimental/hello-world-with-assets/js/vitest.config.js +11 -0
  181. package/templates-experimental/hello-world-with-assets/js/wrangler.toml +12 -0
  182. package/templates-experimental/hello-world-with-assets/py/__dot__gitignore +68 -0
  183. package/templates-experimental/hello-world-with-assets/py/package.json +13 -0
  184. package/templates-experimental/hello-world-with-assets/py/public/index.html +31 -0
  185. package/templates-experimental/hello-world-with-assets/py/src/entry.py +9 -0
  186. package/templates-experimental/hello-world-with-assets/py/wrangler.toml +12 -0
  187. package/templates-experimental/hello-world-with-assets/ts/.editorconfig +12 -0
  188. package/templates-experimental/hello-world-with-assets/ts/.prettierrc +6 -0
  189. package/templates-experimental/hello-world-with-assets/ts/__dot__gitignore +172 -0
  190. package/templates-experimental/hello-world-with-assets/ts/package.json +18 -0
  191. package/templates-experimental/hello-world-with-assets/ts/public/index.html +31 -0
  192. package/templates-experimental/hello-world-with-assets/ts/src/index.ts +26 -0
  193. package/templates-experimental/hello-world-with-assets/ts/test/index.spec.ts +41 -0
  194. package/templates-experimental/hello-world-with-assets/ts/test/tsconfig.json +8 -0
  195. package/templates-experimental/hello-world-with-assets/ts/tsconfig.json +44 -0
  196. package/templates-experimental/hello-world-with-assets/ts/vitest.config.mts +11 -0
  197. package/templates-experimental/hello-world-with-assets/ts/worker-configuration.d.ts +4 -0
  198. package/templates-experimental/hello-world-with-assets/ts/wrangler.toml +12 -0
  199. package/templates-experimental/hono/c3.ts +43 -0
  200. package/templates-experimental/hono/templates/public/index.html +19 -0
  201. package/templates-experimental/hono/templates/src/index.ts +9 -0
  202. package/templates-experimental/hono/templates/worker-configuration.d.ts +4 -0
  203. package/templates-experimental/hono/templates/wrangler.toml +5 -0
  204. package/templates-experimental/next/c3.ts +56 -0
  205. package/templates-experimental/next/templates/__dot__gitignore +42 -0
  206. package/templates-experimental/next/templates/env.d.ts +5 -0
  207. package/templates-experimental/next/templates/wrangler.toml +12 -0
  208. package/templates-experimental/nuxt/c3.ts +135 -0
  209. package/templates-experimental/nuxt/templates/env.d.ts +14 -0
  210. package/templates-experimental/nuxt/templates/worker-configuration.d.ts +4 -0
  211. package/templates-experimental/nuxt/templates/wrangler.toml +11 -0
  212. package/templates-experimental/qwik/c3.ts +153 -0
  213. package/templates-experimental/qwik/snippets/getPlatformProxy.ts +6 -0
  214. package/templates-experimental/qwik/templates/public/.assetsignore +4 -0
  215. package/templates-experimental/qwik/templates/worker-configuration.d.ts +4 -0
  216. package/templates-experimental/qwik/templates/wrangler.toml +12 -0
  217. package/templates-experimental/remix/c3.ts +52 -0
  218. package/templates-experimental/remix/templates/public/.assetsignore +0 -0
  219. package/templates-experimental/remix/templates/worker-configuration.d.ts +4 -0
  220. package/templates-experimental/remix/templates/wrangler.toml +11 -0
  221. package/templates-experimental/solid/c3.ts +94 -0
  222. package/templates-experimental/solid/templates/wrangler.toml +12 -0
  223. package/templates-experimental/svelte/c3.ts +129 -0
  224. package/templates-experimental/svelte/templates/static/.assetsignore +4 -0
  225. package/templates-experimental/svelte/templates/wrangler.toml +11 -0
  226. package/templates-experimental/vue/c3.ts +33 -0
  227. package/templates-experimental/vue/templates/wrangler.toml +10 -0
  228. package/dist/angular/templates/src/main.server.ts +0 -35
  229. package/dist/angular/templates/tools/bundle.mjs +0 -77
  230. package/dist/angular/templates/tools/copy-client-files.mjs +0 -4
  231. package/dist/angular/templates/tools/copy-worker-files.mjs +0 -10
  232. package/dist/angular/templates/tools/paths.mjs +0 -9
  233. package/dist/angular/templates/tsconfig.server.json +0 -5
  234. package/templates/chatgptPlugin/ts/.assets/example.png +0 -0
  235. package/templates/chatgptPlugin/ts/README.md +0 -25
  236. package/templates/chatgptPlugin/ts/package.json +0 -17
  237. package/templates/chatgptPlugin/ts/src/index.ts +0 -33
  238. package/templates/chatgptPlugin/ts/src/search.ts +0 -59
  239. package/templates/chatgptPlugin/ts/wrangler.toml +0 -3
  240. /package/{dist → templates}/angular/templates/src/_routes.json +0 -0
@@ -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"
@@ -0,0 +1,68 @@
1
+ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`c3`](https://developers.cloudflare.com/pages/get-started/c3).
2
+
3
+ ## Getting Started
4
+
5
+ First, run the development server:
6
+
7
+ ```bash
8
+ npm run dev
9
+ # or
10
+ yarn dev
11
+ # or
12
+ pnpm dev
13
+ # or
14
+ bun dev
15
+ ```
16
+
17
+ Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18
+
19
+ ## Cloudflare integration
20
+
21
+ Besides the `dev` script mentioned above `c3` has added a few extra scripts that allow you to integrate the application with the [Cloudflare Pages](https://pages.cloudflare.com/) environment, these are:
22
+ - `pages:build` to build the application for Pages using the [`@cloudflare/next-on-pages`](https://github.com/cloudflare/next-on-pages) CLI
23
+ - `preview` to locally preview your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
24
+ - `deploy` to deploy your Pages application using the [Wrangler](https://developers.cloudflare.com/workers/wrangler/) CLI
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/main/internal-packages/next-dev/README.md#recommended-development-workflow))
27
+
28
+ ### Bindings
29
+
30
+ Cloudflare [Bindings](https://developers.cloudflare.com/pages/functions/bindings/) are what allows you to interact with resources available in the Cloudflare Platform.
31
+
32
+ You can use bindings during development, when previewing locally your application and of course in the deployed application:
33
+
34
+ - To use bindings in dev mode you need to define them in the `next.config.js` file under `setupDevBindings`, this mode uses the `next-dev` `@cloudflare/next-on-pages` submodule. For more details see its [documentation](https://github.com/cloudflare/next-on-pages/blob/05b6256/internal-packages/next-dev/README.md).
35
+
36
+ - To use bindings in the preview mode you need to add them to the `pages:preview` script accordingly to the `wrangler pages dev` command. For more details see its [documentation](https://developers.cloudflare.com/workers/wrangler/commands/#dev-1) or the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
37
+
38
+ - To use bindings in the deployed application you will need to configure them in the Cloudflare [dashboard](https://dash.cloudflare.com/). For more details see the [Pages Bindings documentation](https://developers.cloudflare.com/pages/functions/bindings/).
39
+
40
+ #### KV Example
41
+
42
+ `c3` has added for you an example showing how you can use a KV binding.
43
+
44
+ In order to enable the example:
45
+ - Search for javascript/typescript lines containing the following comment:
46
+ ```ts
47
+ // KV Example:
48
+ ```
49
+ and uncomment the commented lines below it (also uncomment the relevant imports).
50
+ - Do the same in the `wrangler.toml` file, where
51
+ the comment is:
52
+ ```
53
+ # KV Example:
54
+ ```
55
+ - If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
56
+ ```bash
57
+ npm run cf-typegen
58
+ # or
59
+ yarn cf-typegen
60
+ # or
61
+ pnpm cf-typegen
62
+ # or
63
+ bun cf-typegen
64
+ ```
65
+
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
+
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.
@@ -0,0 +1,21 @@
1
+ // import { getRequestContext } from '@cloudflare/next-on-pages'
2
+
3
+ export const runtime = 'edge'
4
+
5
+ export async function GET() {
6
+ const responseText = 'Hello World'
7
+
8
+ // In the edge runtime you can use Bindings that are available in your application
9
+ // (for more details see:
10
+ // - https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#use-bindings-in-your-nextjs-application
11
+ // - https://developers.cloudflare.com/pages/functions/bindings/
12
+ // )
13
+ //
14
+ // KV Example:
15
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
16
+ // await myKv.put('suffix', ' from a KV store!')
17
+ // const suffix = await myKv.get('suffix')
18
+ // return new Response(responseText + suffix)
19
+
20
+ return new Response(responseText)
21
+ }
@@ -0,0 +1,58 @@
1
+ export const runtime = "edge";
2
+
3
+ export default function NotFound() {
4
+ return (
5
+ <>
6
+ <title>404: This page could not be found.</title>
7
+ <div style={styles.error}>
8
+ <div>
9
+ <style
10
+ dangerouslySetInnerHTML={{
11
+ __html: `body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}`,
12
+ }}
13
+ />
14
+ <h1 className="next-error-h1" style={styles.h1}>
15
+ 404
16
+ </h1>
17
+ <div style={styles.desc}>
18
+ <h2 style={styles.h2}>This page could not be found.</h2>
19
+ </div>
20
+ </div>
21
+ </div>
22
+ </>
23
+ );
24
+ }
25
+
26
+ const styles = {
27
+ error: {
28
+ fontFamily:
29
+ 'system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
30
+ height: "100vh",
31
+ textAlign: "center",
32
+ display: "flex",
33
+ flexDirection: "column",
34
+ alignItems: "center",
35
+ justifyContent: "center",
36
+ },
37
+
38
+ desc: {
39
+ display: "inline-block",
40
+ },
41
+
42
+ h1: {
43
+ display: "inline-block",
44
+ margin: "0 20px 0 0",
45
+ padding: "0 23px 0 0",
46
+ fontSize: 24,
47
+ fontWeight: 500,
48
+ verticalAlign: "top",
49
+ lineHeight: "49px",
50
+ },
51
+
52
+ h2: {
53
+ fontSize: 14,
54
+ fontWeight: 400,
55
+ lineHeight: "49px",
56
+ margin: 0,
57
+ },
58
+ };
@@ -0,0 +1,21 @@
1
+ // import { getRequestContext } from '@cloudflare/next-on-pages'
2
+
3
+ export const runtime = 'edge'
4
+
5
+ export async function GET() {
6
+ const responseText = 'Hello World'
7
+
8
+ // In the edge runtime you can use Bindings that are available in your application
9
+ // (for more details see:
10
+ // - https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#use-bindings-in-your-nextjs-application
11
+ // - https://developers.cloudflare.com/pages/functions/bindings/
12
+ // )
13
+ //
14
+ // KV Example:
15
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
16
+ // await myKv.put('suffix', ' from a KV store!')
17
+ // const suffix = await myKv.get('suffix')
18
+ // return new Response(responseText + suffix)
19
+
20
+ return new Response(responseText)
21
+ }
@@ -0,0 +1,58 @@
1
+ export const runtime = "edge";
2
+
3
+ export default function NotFound() {
4
+ return (
5
+ <>
6
+ <title>404: This page could not be found.</title>
7
+ <div style={styles.error}>
8
+ <div>
9
+ <style
10
+ dangerouslySetInnerHTML={{
11
+ __html: `body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}`,
12
+ }}
13
+ />
14
+ <h1 className="next-error-h1" style={styles.h1}>
15
+ 404
16
+ </h1>
17
+ <div style={styles.desc}>
18
+ <h2 style={styles.h2}>This page could not be found.</h2>
19
+ </div>
20
+ </div>
21
+ </div>
22
+ </>
23
+ );
24
+ }
25
+
26
+ const styles = {
27
+ error: {
28
+ fontFamily:
29
+ 'system-ui,"Segoe UI",Roboto,Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji"',
30
+ height: "100vh",
31
+ textAlign: "center",
32
+ display: "flex",
33
+ flexDirection: "column",
34
+ alignItems: "center",
35
+ justifyContent: "center",
36
+ },
37
+
38
+ desc: {
39
+ display: "inline-block",
40
+ },
41
+
42
+ h1: {
43
+ display: "inline-block",
44
+ margin: "0 20px 0 0",
45
+ padding: "0 23px 0 0",
46
+ fontSize: 24,
47
+ fontWeight: 500,
48
+ verticalAlign: "top",
49
+ lineHeight: "49px",
50
+ },
51
+
52
+ h2: {
53
+ fontSize: 14,
54
+ fontWeight: 400,
55
+ lineHeight: "49px",
56
+ margin: 0,
57
+ },
58
+ } as const;
@@ -0,0 +1,238 @@
1
+ import { join } from "path";
2
+ import { updateStatus, warn } from "@cloudflare/cli";
3
+ import { brandColor, dim } from "@cloudflare/cli/colors";
4
+ import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
5
+ import { runFrameworkGenerator } from "frameworks/index";
6
+ import {
7
+ copyFile,
8
+ probePaths,
9
+ readFile,
10
+ readJSON,
11
+ usesEslint,
12
+ usesTypescript,
13
+ writeFile,
14
+ writeJSON,
15
+ } from "helpers/files";
16
+ import { detectPackageManager } from "helpers/packageManagers";
17
+ import { installPackages } from "helpers/packages";
18
+ import { getTemplatePath } from "../../src/templates";
19
+ import type { TemplateConfig } from "../../src/templates";
20
+ import type { C3Context } from "types";
21
+
22
+ const { npm, npx } = detectPackageManager();
23
+
24
+ const generate = async (ctx: C3Context) => {
25
+ const projectName = ctx.project.name;
26
+
27
+ await runFrameworkGenerator(ctx, [projectName]);
28
+
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}`,
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
+
49
+ updateStatus("Created wrangler.toml file");
50
+ };
51
+
52
+ const updateNextConfig = (usesTs: boolean) => {
53
+ const s = spinner();
54
+
55
+ const configFile = `next.config.${usesTs ? "ts" : "mjs"}`;
56
+ s.start(`Updating \`${configFile}\``);
57
+
58
+ const configContent = readFile(configFile);
59
+
60
+ const updatedConfigFile =
61
+ `import { setupDevPlatform } from '@cloudflare/next-on-pages/next-dev';
62
+
63
+ // Here we use the @cloudflare/next-on-pages next-dev module to allow us to use bindings during local development
64
+ // (when running the application with \`next dev\`), for more information see:
65
+ // https://github.com/cloudflare/next-on-pages/blob/main/internal-packages/next-dev/README.md
66
+ if (process.env.NODE_ENV === 'development') {
67
+ await setupDevPlatform();
68
+ }
69
+
70
+ `.replace(/\n\t*/g, "\n") + configContent;
71
+
72
+ writeFile(configFile, updatedConfigFile);
73
+
74
+ s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
75
+ };
76
+
77
+ const configure = async (ctx: C3Context) => {
78
+ const projectPath = ctx.project.path;
79
+
80
+ // Add a compatible function handler example
81
+ const path = probePaths([
82
+ `${projectPath}/pages/api`,
83
+ `${projectPath}/src/pages/api`,
84
+ `${projectPath}/src/app/api`,
85
+ `${projectPath}/app/api`,
86
+ `${projectPath}/src/app`,
87
+ `${projectPath}/app`,
88
+ ]);
89
+
90
+ if (!path) {
91
+ throw new Error("Could not find the `/api` or `/app` directory");
92
+ }
93
+
94
+ const usesTs = usesTypescript(ctx);
95
+
96
+ if (usesTs) {
97
+ copyFile(
98
+ join(getTemplatePath(ctx), "env.d.ts"),
99
+ join(projectPath, "env.d.ts"),
100
+ );
101
+ updateStatus("Created an env.d.ts file");
102
+ }
103
+
104
+ const installEslintPlugin = await shouldInstallNextOnPagesEslintPlugin(ctx);
105
+
106
+ if (installEslintPlugin) {
107
+ await writeEslintrc(ctx);
108
+ }
109
+
110
+ updateNextConfig(usesTs);
111
+
112
+ copyFile(
113
+ join(getTemplatePath(ctx), "README.md"),
114
+ join(projectPath, "README.md"),
115
+ );
116
+ updateStatus("Updated the README file");
117
+
118
+ await addDevDependencies(installEslintPlugin);
119
+ };
120
+
121
+ export const shouldInstallNextOnPagesEslintPlugin = async (
122
+ ctx: C3Context,
123
+ ): Promise<boolean> => {
124
+ const eslintUsage = usesEslint(ctx);
125
+
126
+ if (!eslintUsage.used) {
127
+ return false;
128
+ }
129
+
130
+ if (eslintUsage.configType !== ".eslintrc.json") {
131
+ warn(
132
+ `Expected .eslintrc.json from Next.js scaffolding but found ${eslintUsage.configType} instead`,
133
+ );
134
+ return false;
135
+ }
136
+
137
+ return await inputPrompt({
138
+ type: "confirm",
139
+ question: "Do you want to use the next-on-pages eslint-plugin?",
140
+ label: "eslint-plugin",
141
+ defaultValue: true,
142
+ });
143
+ };
144
+
145
+ export const writeEslintrc = async (ctx: C3Context): Promise<void> => {
146
+ const eslintConfig = readJSON(`${ctx.project.path}/.eslintrc.json`);
147
+
148
+ eslintConfig.plugins ??= [];
149
+ eslintConfig.plugins.push("eslint-plugin-next-on-pages");
150
+
151
+ if (typeof eslintConfig.extends === "string") {
152
+ eslintConfig.extends = [eslintConfig.extends];
153
+ }
154
+ eslintConfig.extends ??= [];
155
+ eslintConfig.extends.push("plugin:eslint-plugin-next-on-pages/recommended");
156
+
157
+ writeJSON(`${ctx.project.path}/.eslintrc.json`, eslintConfig);
158
+ };
159
+
160
+ const addDevDependencies = async (installEslintPlugin: boolean) => {
161
+ const packages = [
162
+ "@cloudflare/next-on-pages@1",
163
+ "@cloudflare/workers-types",
164
+ "vercel",
165
+ ...(installEslintPlugin ? ["eslint-plugin-next-on-pages"] : []),
166
+ ];
167
+ await installPackages(packages, {
168
+ dev: true,
169
+ startText: "Adding the Cloudflare Pages adapter",
170
+ doneText: `${brandColor(`installed`)} ${dim(packages.join(", "))}`,
171
+ });
172
+ };
173
+
174
+ export default {
175
+ configVersion: 1,
176
+ id: "next",
177
+ frameworkCli: "create-next-app",
178
+ platform: "pages",
179
+ displayName: "Next",
180
+ generate,
181
+ configure,
182
+ copyFiles: {
183
+ async selectVariant(ctx) {
184
+ const isApp = probePaths([
185
+ `${ctx.project.path}/src/app`,
186
+ `${ctx.project.path}/app`,
187
+ ]);
188
+
189
+ const isTypescript = usesTypescript(ctx);
190
+
191
+ const dir = isApp ? "app" : "pages";
192
+ return `${dir}/${isTypescript ? "ts" : "js"}`;
193
+ },
194
+ destinationDir(ctx) {
195
+ const srcPath = probePaths([`${ctx.project.path}/src`]);
196
+ return srcPath ? "./src" : "./";
197
+ },
198
+ variants: {
199
+ "app/ts": {
200
+ path: "./app/ts",
201
+ },
202
+ "app/js": {
203
+ path: "./app/js",
204
+ },
205
+ "pages/ts": {
206
+ path: "./pages/ts",
207
+ },
208
+ "pages/js": {
209
+ path: "./pages/js",
210
+ },
211
+ },
212
+ },
213
+ transformPackageJson: async (_, ctx) => {
214
+ const isNpm = npm === "npm";
215
+ const isBun = npm === "bun";
216
+ const isNpmOrBun = isNpm || isBun;
217
+ const nextOnPagesScope = isNpmOrBun ? "@cloudflare/" : "";
218
+ const nextOnPagesCommand = `${nextOnPagesScope}next-on-pages`;
219
+ const pmCommand = isNpmOrBun ? npx : npm;
220
+ const pagesBuildRunCommand = `${
221
+ isNpm ? "npm run" : isBun ? "bun" : pmCommand
222
+ } pages:build`;
223
+ return {
224
+ scripts: {
225
+ "pages:build": `${pmCommand} ${nextOnPagesCommand}`,
226
+ preview: `${pagesBuildRunCommand} && wrangler pages dev`,
227
+ deploy: `${pagesBuildRunCommand} && wrangler pages deploy`,
228
+ ...(usesTypescript(ctx) && {
229
+ "cf-typegen": `wrangler types --env-interface CloudflareEnv env.d.ts`,
230
+ }),
231
+ },
232
+ };
233
+ },
234
+ devScript: "dev",
235
+ previewScript: "preview",
236
+ deployScript: "deploy",
237
+ compatibilityFlags: ["nodejs_compat"],
238
+ } as TemplateConfig;
@@ -0,0 +1,5 @@
1
+ // Generated by Wrangler
2
+ // by running `wrangler types --env-interface CloudflareEnv env.d.ts`
3
+
4
+ interface CloudflareEnv {
5
+ }
@@ -0,0 +1,23 @@
1
+ import { getRequestContext } from '@cloudflare/next-on-pages'
2
+
3
+ export const config = {
4
+ runtime: 'edge',
5
+ }
6
+
7
+ export default async function handler(req) {
8
+ let responseText = 'Hello World'
9
+
10
+ // In the edge runtime you can use Bindings that are available in your application
11
+ // (for more details see:
12
+ // - https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#use-bindings-in-your-nextjs-application
13
+ // - https://developers.cloudflare.com/pages/functions/bindings/
14
+ // )
15
+ //
16
+ // KV Example:
17
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
18
+ // await myKv.put('suffix', ' from a KV store!')
19
+ // const suffix = await myKv.get('suffix')
20
+ // responseText += suffix
21
+
22
+ return new Response(responseText)
23
+ }
@@ -0,0 +1,24 @@
1
+ import type { NextRequest } from 'next/server'
2
+ import { getRequestContext } from '@cloudflare/next-on-pages'
3
+
4
+ export const config = {
5
+ runtime: 'edge',
6
+ }
7
+
8
+ export default async function handler(req: NextRequest) {
9
+ let responseText = 'Hello World'
10
+
11
+ // In the edge runtime you can use Bindings that are available in your application
12
+ // (for more details see:
13
+ // - https://developers.cloudflare.com/pages/framework-guides/deploy-a-nextjs-site/#use-bindings-in-your-nextjs-application
14
+ // - https://developers.cloudflare.com/pages/functions/bindings/
15
+ // )
16
+ //
17
+ // KV Example:
18
+ // const myKv = getRequestContext().env.MY_KV_NAMESPACE
19
+ // await myKv.put('suffix', ' from a KV store!')
20
+ // const suffix = await myKv.get('suffix')
21
+ // responseText += suffix
22
+
23
+ return new Response(responseText)
24
+ }