https://github.com/nzambello/plone-remix
Remix frontend for Plone 6
https://github.com/nzambello/plone-remix
plone plone6 react remix-run remix-stack volto
Last synced: 8 months ago
JSON representation
Remix frontend for Plone 6
- Host: GitHub
- URL: https://github.com/nzambello/plone-remix
- Owner: nzambello
- License: gpl-3.0
- Created: 2022-03-17T18:59:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-12T15:19:33.000Z (about 3 years ago)
- Last Synced: 2025-01-09T10:49:36.641Z (9 months ago)
- Topics: plone, plone6, react, remix-run, remix-stack, volto
- Language: TypeScript
- Homepage: https://plone-remix-demo.pages.dev/
- Size: 354 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Plone Remix Stack
[Remix](https://remix.run/stacks) stack for [Plone 6](https://plone.org/), the enterprise open-source CMS.
Handles multilanguage routing, navigation, and content rendering.
Supports [Volto](https://github.com/plone/volto) blocks with [volto-slate](https://github.com/plone/volto/tree/master/packages/volto-slate) text blocks.
Learn more about [Remix Stacks](https://remix.run/stacks).
```sh
npx create-remix --template raw-material/plone-remix
```
## What's in the stack
### i18n
- [remix-i18next](https://github.com/sergiodxa/remix-i18next)
### Plone REST API TypeScript Client
- [plone-restapi-client](https://github.com/collective/plone-restapi-client)
### Linting and formatting
- [Prettier](https://prettier.io)
- [ESLint](https://eslint.org)
- [StyleLint](https://stylelint.io/)
- [Husky](https://typicode.github.io/husky/#/)
- [Commitlint](https://commitlint.js.org/#/)
### Release
- [Commitlint](https://commitlint.js.org/#/)
- [Release-it](https://github.com/release-it/release-it)
### Misc
- [Storybook](https://storybook.js.org)
- [GitHub Actions](https://github.com/nzambello/vite-react-template/actions)
### Make it yours
In the `package.json` file, check `release-it`, `eslint`, `stylelint` and `prettier` configurations and change the values to match your project and your preferences.
## Getting started
Use this template:
```sh
npx create-remix --template raw-material/plone-remix
```
Or clone this template:
```sh
npx degit raw-material/plone-remix
```
And setup your environment variables:
```sh
mv .env.example .env
```
### Configuration
The stack is configured to work with a Plone site running on `http://localhost:8080/Plone` with the `plone.restapi` addon installed.
Check the `.env` file to change the configuration.
Setup your project settings in `app/config.tsx` as you do in Volto.
## Development
From your terminal:
```sh
npm run dev
```
This starts your app in development mode, rebuilding assets on file changes.
## Deployment
First, build your app for production:
```sh
npm run build
```
Then run the app in production mode:
```sh
npm start
```
Now you'll need to pick a host to deploy it to.
### DIY
If you're familiar with deploying node applications, the built-in Remix app server is production-ready.
Make sure to deploy the output of `remix build`
- `build/`
- `public/build/`