README

The Neos CMS interface written in ReactJS and a ton of other fun technology.

Versioning

This repository follows the same versioning scheme as Neos itself. Release roadmap is available here

That means:

All bugfixes go to the lowest maintained branch
All new features go only to the 8.4 and 9.0 branch
New minor and major releases are made in sync with Neos/Flow. Bugfix releases may be available independently

Currently maintained versions

NeosCMS version 8.3: branch 8.3
NeosCMS version 8.3: branch 8.4
NeosCMS version 9.0: branch 9.0
latest development happens currently in the 8.4 and 9.0 branch

Releases with just security updates

NeosCMS version 7.3: branch 7.3
NeosCMS version 8.0: branch 8.0
NeosCMS version 8.1: branch 8.1
NeosCMS version 8.2: branch 8.2

Browser support

The new interface supports all evergreen (i.e. self-updating) browsers, including: Chrome, Firefox, Safari, Edge, Opera and other webkit-based browsers.

If you discover bugs in any of the supported browsers, please report them!

Features

Blazingly fast Yarn 3 + ESbuild stack
https://www.neos.io/features/editing-content.html
https://www.neos.io/features/inline-editing-true-wysiwyg.html

Installation and usage

The UI is already included in the base Neos distribution. And on Packagist available via: neos/neos-ui

Updating

composer update neos/neos-ui

Installing latest development

For trying out the new UI, we recommend you to run the regularly released beta releases. However, if you want to stay on bleeding-edge, or want to help out developing, you'll need the 9.0.x-dev release. You can install the latest release using:

composer require neos/neos-ui-compiled:9.0.x-dev neos/neos-ui:9.0.x-dev

Contributing

Please follow the respective guides for contributing on OSX and on Linux.

To start developing the Neos Ui you will need a running Neos instance locally. You can use

one of your own, local Neos 8.3 instances,
create a new one with composer create-project neos/neos-base-distribution neos-ui-development-instance,
or use the docker compose setup in this repository (see instructions below).

Setup Source Files and Git

To install the source files and setup git, run:

composer require neos/neos-ui-compiled:9.0.x-dev neos/neos-ui:9.0.x-dev --prefer-source

This will sync the git repository of Neos Ui into Packages/Application/Neos.Neos.Ui (this might take a while). To push your changes to GitHub you need to fork the Neos Ui and change the git remote to your fork (check with git remove -v).

Run make setup. To check what commands are executed have a look at the Makefile in the root of this repository.

on Windows

Ensure you have the relevant version installed (see above).
Please install Docker for Windows.
Run docker-compose up.
Inside Configuration/Settings.yaml, set the following property for disabling the pre-compiled files:

Neos:
  Neos:
    Ui:
      frontendDevelopmentMode: true

Get an overview about the codebase. We've recorded an introduction on YouTube which gets you acquainted with the basics. Additionally, please get in touch with us on Slack in the channel #project-ui-rewrite. We're eager to help you get started!

on OSX / Linux

In order to start contributing on OSX / Linux, follow the following steps:

Ensure you have the relevant version installed (see above).
We require Chrome as well as the yarn(https://yarnpkg.com/en/) command and GNU Make(https://www.gnu.org/software/make/) to be installed on your system.
The currently supported version of node is defined in .nvmrc file. If you have nvm installed, you can just run nvm install && nvm use from the project directory.
Inside Configuration/Settings.yaml, set the following property for disabling the pre-compiled files:

Neos:
  Neos:
    Ui:
      frontendDevelopmentMode: true

Run the initialization script:

make setup

Get an overview about the codebase. We've recorded an introduction on YouTube which gets you acquainted with the basics. Additionally, please get in touch with us on Slack in the channel #project-ui-rewrite. We're eager to help you get started!

Guideline for PR and commit messages

Please see our guideline on how to write meaningful descriptions for your contributions.

Doing upmerges

To do the upmerge run the following commands

# review and `git commit`
git checkout 8.0 && git fetch && git reset --hard origin/8.0 && git merge --no-ff --no-commit origin/7.3
# review and `git commit`
git checkout 8.1 && git fetch && git reset --hard origin/8.1 && git merge --no-ff --no-commit origin/8.0
# review and `git commit`
git checkout 8.2 && git fetch && git reset --hard origin/8.2 && git merge --no-ff --no-commit origin/8.1
# review and `git commit`
git checkout 8.3 && git fetch && git reset --hard origin/8.3 && git merge --no-ff --no-commit origin/8.2
# review and `git commit`
git checkout 8.4 && git fetch && git reset --hard origin/8.4 && git merge --no-ff --no-commit origin/8.3
# review and `git commit`
git checkout 9.0 && git fetch && git reset --hard origin/9.0 && git merge --no-ff --no-commit origin/8.4
# review and `git commit`

Development commands

Command	Description
`make clean`	delete all node_modules in every subdirectory.
`make build`	Runs the development build for neos-ui once.
`make build-watch`	Starts a watcher process, which automatically runs a build for neos-ui, everytime a resource file (like JavaScript and CSS) changes.
`make lint`	Executes `make lint-js` and `make lint-editorconfig`.
`make lint-js`	Runs test in all subpackages.
`make lint-editorconfig`	Tests if all files respect the `.editorconfig`.
`make test`	Executes the test on all source files.

Writing unit tests

The unit tests are executed with jest. To run the unit tests, execute make test in your shell.

Adding unit tests is fairly simple, just create a file on the same tree level as your changed/new feature, named [filename].spec.js and karma will execute all tests found within the spec file, other than that, just orient yourself on the existing tests.

Use it.only(() => {}) and describe.only(() => {}) if you want to run a specific test and not the whole test suite.

E2E tests with Playwright & Docker

E2E tests use Playwright with playwright-bdd for Gherkin scenarios and run against a Dockerised Neos instance — no local Neos installation needed. See Tests/E2E/README.md for full details.

Prerequisites: Docker, Node.js ≥ 24, make

Quick start:

cd Tests/E2E
make setup                   # build SUT image, install deps, generate test files
make test                    # run all tests (auto-starts and tears down the SUT)

During development — keep the SUT running for a faster feedback loop:

make start-sut               # start SUT in the background (localhost:8081)
REUSE_EXISTING_SUT=1 npm run test -- --grep "My feature"   # run without rebooting
make test-ui                 # interactive Playwright UI
make enter-sut               # bash shell inside the SUT container
make log-sut                 # stream SUT logs
make sut-down                # stop containers and delete volumes

Writing tests: add a .feature file under Tests/E2E/features/ and a matching *.steps.ts under Tests/E2E/steps/. After editing feature files run make generate-bdd-files (done automatically by make setup and make test).

Debugging integration tests

The GitHub action is uploading artefacts that can be downloaded as a zip file, e.g. Artifact download URL: https://github.com/neos/neos-ui/actions/runs/26954395116/artifacts/7413021306

Releasing

You only need to trigger the jenkins release with the version you want to release. After jenkins has finished you need release a new version on github.

License

see LICENSE

neos / neos-ui

Maintainers

Package info

Fund package maintenance!

Statistics

Security