@neos/neos-ui

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

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 v4.5.0 (old icon names are migrated on the fly).

Installation

Run the following commands:

composer require neos/neos-ui:dev-master # install our package
cd Packages/Application/Neos.Neos.Ui
source Build/init.sh # do NodeJS stuff ie. install required node version using nvm, install npm deps
npm run build # build everything using webpack (you might see some webpack warnings, but you can ignore them)

Paste the following configuration into the head of your global Routes.yaml which is located in Configuration/

name: 'Neos UI' uriPattern: '' subRoutes: 'NeosUiSubroutes': package: 'Neos.Neos.Ui'

Now you are all set up and can open the sub-route /neos! to login to the new interface.

Note: We require nvm as well as the npm command to be installed on your system. If you've installed nvm make sure that the next node LTS version 6.1.0 is correctly installed - You can do so by executing nvm install v6.1.0. If you need help setting up nvm, npm or if you got any other problems, join our Slack channel and we are most happy to help you with it. :).

Contributing

Read developer documentation on our wiki.

Development commands

Command	Description
`npm run build`	Builds all assets via webpack.
`npm run lint:scripts`	Lints all `.js` files via ESLint.
`npm run lint:css`	Lints all `.css` files via StyleLint.
`npm run lint`	Runs the above stated watch commands sequentially.
`npm run karma`	Executes a single run of all unit tests via karma. (This is pretty slow due to webpack's single-compilation speed, use the `watch:karma` task instead for development)
`npm run selenium:init`	Installs and boots the selenium server. See Writing integration tests for more info.
`npm run selenium:run`	Executes all integration tests via WebdriverIO. See Writing integration tests for more info.
`npm run watch:build`	Watches all source files and rebuilds the compiled files on file changes.
`npm run watch:karma`	Watches all source files and unit test specs and runs karma after the compilation has been completed.
`npm run watch`	Runs the above stated watch commands sequentially.
`npm test`	Executes both `npm run lint` and `npm run karma` sequentially.

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 npm run lint in your shell.

Writing unit tests

The unit tests are executed with Karma and PhantomJS. Instead of relying on the default settings of Karma, we use chai as our assertion library and sinon for spies. To run the unit tests, execute npm run karma 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.

Writing integration tests

The integration tests are running on a selenium grid which is installed & started by the npm run selenium:init command, and executed by WebdriverIO. Assertions are written with chai. To run the integration tests, execute npm run selenium:init first, and npm run selenium:run in a separate session afterwards.

Adding user stories is as simple as creating unit tests, the only difference is that the file needs to be placed in the Tests root directory and should end with *.story.js instead of *.spec.js.

Since acceptance testing can be relatively time-intensive, it’s important to plan how to organize your tests. It is possible to organize your tests by creating multiple configuration files: each file can define a different list of “specs” directories. Additionally, Mocha’s “grep” option is exposed to the --mochaOpts option, so you can use it to perform pattern matching on your test descriptions:

npm run selenium:run -- --mochaOpts.grep "should persist the changes"

Libraries which are used by the application

Name	Description/Usecase
immutable	Transforms data into immutable structures. Read more
redux	Handles the state of the application in general. Read more
react	The view layer on which the UI is based upon.
react-motion / react-motion-ui-pack	Simple animations in react.
@reduct/component	Used for low-level components which interact directly with server side rendered markup.

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.

ryzy/neos-ui