The next generation Neos CMS interface written in ReactJS with Immutable data structures.

The new interface supports all evergreen (i.e. self-updating) browsers, including: Chrome, Firefox, Safari, Edge, Opera and other webkit-based browsers. In addition IE11 should also work, but please try to use more modern browsers, as the performance might suffer. If you discover bugs in any of the supported browsers, please report them!

• 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).

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

1. You need to have Neos CMS 3.3 or newer up & running.

2. Run the following command:

   composer require neos/neos-ui neos/neos-ui-compiled
   

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

composer update neos/neos-ui neos/neos-ui-compiled

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 neos/neos-ui-compiled:dev-master

In order to start contributing, follow the following steps:

1. Ensure you have the dev-master version installed (see above).

2. 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.

3. 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.

4. Inside Configuration/Settings.yaml, set the following property for disabling the pre-compiled files:

   Neos:
     Neos:
       Ui:
         frontendDevelopmentMode: true
   

5. Run the initialization script:

   make setup
   

6. 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!

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'
};

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.

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.

For end to end testing we use the headless chrome. So it is mandatory to install the chrome browser for integration tests. Since Chrome 59 the headless mode is integrated. So please install a Chome 59 or higher to execute the end to end tests.

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.

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.