@neos/neos-ui

The next generation Neos CMS interface written in ReactJS and a tonn of other fun technology.

Versioning

Since Neos 5.0 (scheduled April 2019) this repository will become obsolete and neos-ui will be versioned and releases together with with the rest of Neos core packages.

Until then, the following version conventions are in place:

2.x versions are Neos 3.3 compatible (released from the 2.x branch)
3.x branch is Neos 4.x compatible (released from master)
We follow semver, but do not make bugfix releases for previous minor branches

For users this means: You will not get bugfixes for previous minor releases, so use a more relaxed version constraint like these:

"neos/neos-ui": "^3",

For developers this means: All development happens in 2.x branch and then getting upmered to master

Browser support

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

In order to get IE11 to work, please switch to CKEditor 4, as CKEditor 5 doesn't support it. But doing so is highly discouraged, so where possibly encourage your editors to use modern browsers.

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

Features

Better editing experience for responsive websites.
Faster load times for the backend.
No reload constraint for the correct stylesheets on multi-site systems.
Updated Font-Awesome to v5.0 (old icon names are migrated on the fly).

Installation and usage

The new UI is already included in the base Neos distribution. If you don't have it installed yet, follow these steps:

You need to have Neos CMS 3.3 or newer up & running.
Run the following command:

composer require neos/neos-ui

Now you are all set up and you can login to the new interface as usual via /neos route.

Updating

composer update neos/neos-ui

Installing dev-master

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

composer require neos/neos-ui:dev-master

Contributing

In order to start contributing, follow the following steps:

Ensure you have the 2.x or dev-master 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!

Doing upmerges

Develop only in the 2.x branch, unless this feature is only compatible with Neos 4.x, then in master
To do the upmerge do the following commands

git checkout master && git fetch && git reset --hard origin/master && git merge --no-ff --no-commit origin/2.x --strategy-option=ours

Review the changes and commit the changes with the following commit message:

MERGE: Merge branch '2.x' into master

Development commands

Command	Description
`make clean`	delete all node_modules in every subdirectory.
`make build`	Runs the development build.
`make build-watch`	Watches the source files for changes and runs a build in case.
`make build-watch-poll`	Watches (and polls) the source files on a file share. Should preferably be used when working an a VM for example.
`make storybook`	Starts the storybook server on port 9001.
`make lint`	Executes `make lint-js` and `make lint-editorconfig`.
`make lint-js`	Runs test in all subpackages via lerna.
`make lint-editorconfig`	Tests if all files respect the `.editorconfig`.
`make test`	Executes the test on all source files.
`make test-e2e`	Executes integration tests.

Custom webpack live reload options

If you are developing inside a virtual machine and you are running the watch command on your local system it is may be needed for you to adjust the live reload optons.

This can be done by putting an .webpack.livereload.local.js inside the repository root.

An example file would look like this:

module.exports = {
    protocol: 'http',
    port: '123',
    hostname: 'localhost'
};

Code style

Our code style is based upon xo, with one big difference - We use 4 spaces instead of tabs, to align our code style a bit with the PSR-2 standard for our PHP codebase. To lint the code, execute make lint in your shell.

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.

Integration tests

To setup end-to-end tests locally you have got to do the same things described in CircleCI workflow, namely take the test disribution and composer install in it, put the right branch into Neos.Neos.Ui folder and run webserver and mysql server with the same config as described in the test distribution's Settings.yaml (or adjust it).

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

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Sebobo / neos-ui