Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <[email protected]>
  • Loading branch information
sneridagh and stevepiercy authored Apr 24, 2024
1 parent 97c56b4 commit 1cbcb66
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions docs/source/contributing/developing-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,57 +289,60 @@ Used by Volto, you can also use it in other JavaScript frameworks and environmen
## Supported frameworks

Plone supports several frontend implementations, the main one being Volto as the default frontend and reference React-based implementation.
The others are currently under heavy development, marked as experimental and for now, they remain as a proof of concept.

Other frontends are currently under heavy development.
They are marked as experimental and, for now, they are a proof of concept demonstrating that other frontends are possible.
Although they do work now in an acceptable way, the implementation might change in the future.
Please note that these implementations only show how to access the public Plone content in the current site and dealing with data fetching and routing.
They use the Plone Frontend Strategic Packages (`@plone/registry`, `@plone/client`, `@plone/components`, etc).
These implementations only show how to access the public Plone content in the current site, dealing with data fetching and routing.
All implementations are located in the `apps` directory in a subdirectory according to their implementation name.
They use the Plone frontend strategic packages, including `@plone/registry`, `@plone/client`, and `@plone/components`.

### Plone

The default frontend and reference React-based implementation in Plone is Volto.
In the `apps` folder you'll find a Volto project scaffolding that uses Volto as a library.
In the `apps` folder, you'll find a Volto project scaffolding that uses Volto as a library.
This is the same as the one that you'll have when running the Volto generator or `cookiecutter-plone-starter`.

### Next.js

This is the proof of concept using Next.js with Plone.
This frontend is a proof of concept using Next.js with Plone.

You can try it out using:
You can try it out using the following command.

```
```shell
pnpm --filter plone-nextjs dev
```

### Remix

This is the proof of concept using Remix with Plone.
This frontend is a proof of concept using Remix with Plone.

You can try it out using:
You can try it out using the following command.

```
```shell
pnpm --filter plone-remix dev
```

### Vite build (client only)

This is the proof of concept using a custom client build based in Vite with Plone.
It uses `@tanstack/router` in combination with `@plone/client` (which in turns uses `@tanstack/query`).
This frontend is a proof of concept using a custom client build based in Vite with Plone.
It uses `@tanstack/router` in combination with `@plone/client`, which in turns uses `@tanstack/query`.
This build is suitable for applications that do not need server side generation, and it's client only.

You can try it out using:
You can try it out using the following command.

```
```shell
pnpm --filter plone-vite dev
```

### Vite SSR build

This is the proof of concept using a custom build based in Vite with SSR with Plone.
This frontend is a proof of concept using a custom build, based in Vite with SSR with Plone.
It uses `@tanstack/router` in combination with `@plone/client` (which in turns uses `@tanstack/query`).

You can try it out using:
You can try it out using the following command.

```
```shell
pnpm --filter plone-vite-ssr dev
```

Expand Down

0 comments on commit 1cbcb66

Please sign in to comment.