Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 3.42 KB

README.md

File metadata and controls

58 lines (40 loc) · 3.42 KB
Raw

This is a Next.js project bootstrapped with c3.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Cloudflare integration

Besides the dev script mentioned above c3 has added a few extra scripts that allow you to integrate the application with the Cloudflare Pages environment, these are:

  • pages:build to build the application for Pages using the @cloudflare/next-on-pages CLI
  • preview to locally preview your Pages application using the Wrangler CLI
  • deploy to deploy your Pages application using the Wrangler CLI

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)

Bindings

Cloudflare Bindings are what allows you to interact with resources available in the Cloudflare Platform.

You can use bindings during development, when previewing locally your application and of course in the deployed application:

  • 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.

  • 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 or the Pages Bindings documentation.

  • To use bindings in the deployed application you will need to configure them in the Cloudflare dashboard. For more details see the Pages Bindings documentation.

KV Example

c3 has added for you an example showing how you can use a KV binding.

In order to enable the example:

  • Search for javascript/typescript lines containing the following comment: 
    // KV Example:
    and uncomment the commented lines below it.
  • Do the same in the wrangler.toml file, where the comment is: 
    # KV Example:

After doing this you can run the dev or preview script and visit the /api/hello route to see the example in action.

Finally, if you also want to see the example work in the deployed application make sure to add a MY_KV binding to your Pages application in its dashboard kv bindings settings section. After having configured it make sure to re-deploy your application.