Skip to content

Commit

Permalink
docs: add docs to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
NachoVazquez committed Aug 26, 2023
1 parent 9e262c8 commit 49dff6e
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion packages/plugins/nx-cloudflare/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ Nx plugin for Cloudflare, in particular Cloudflare workers.
- ✅ Include Fetch Handler template
- ✅ Include Scheduled Handler template
- ✅ Vitest tests support
- ✅ Serve and Publish executors
- ✅ Serve and Publish executors for workers.
-[Experimental] Cloudflare Pages builder for Next.JS projects.

## Installation

Expand Down Expand Up @@ -78,6 +79,33 @@ The available options are the following:
nx publish <my-app>
```

### Build Next application.

> This feature is experimental. We appreciate that you let us know of any issues that you find.
To start using the Cloudflare Pages Next builder, start by replacing the builder executor in your application `project.json`.

```json
...
"targets": {
...
"build": {
"executor": "@naxodev/nx-cloudflare:next-build",
...
},
...
```

Notice that you can use the same configurations as in the `@nx/next:build` executor.

Now you can run the build command.

```sh
nx build <app-name>
```

And upload the content of the folder `.vercel/output/static` contained in the folder matching your configured output path.

## Acknowledgement

This project is heavily inspired in the work done by other Nx Champions, check out their projects.
Expand Down

0 comments on commit 49dff6e

Please sign in to comment.