@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 and usage

1. You need to have latest Neos CMS 3.0 up & running.

2. Run the following commands:

   composer require neos/neos-ui:dev-master neos/neos-ui-compiled:dev-master # install our package
   

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

Use Docker image

Alternatively, instead of doing above setup steps manually, use Docker. The million12/neos-react-ui contains Neos CMS, correct version of NodeJS/nvm and neos/neos-ui package installed and built, working out of the box.

Refer to million12/neos-react-ui documentation about how to use it.

Contributing

In order to start contributing, follow the following steps:

1. 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.3.0 is correctly installed - You can do so by executing nvm install v6.3.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. :).__

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

   Neos:
     Neos:
       Ui:
         frontendDevelopmentMode: true
   

3. Run the initialization script:

   cd Packages/Application/Neos.Neos.Ui
   source Build/init.sh # do NodeJS stuff ie. install required node version using nvm, install npm deps, copy githooks
   npm run build # build everything using webpack (you might see some webpack warnings, but you can ignore them)
   

Read developer documentation on our wiki.

Development commands

Command	Description
npm run clear	delete all node_modules in every subdirectory.
npm run build:ui	Builds the ui via webpack.
npm run build:components	Builds the components.
npm run build	Runs the both build commands above sequentially.
npm run build:ui:watch	Watches the source files for changes and runs a build:ui in case.
npm run build:components:watch	Watches the source files for changes and runs a build:components in case.
npm run build:components:watch	Watches the source files for changes and runs a build:components in case.
npm start-storybook	Starts the storybook server.
npm run lint	Lints all source files.
npm run test	Executes npm run lint to trigger tests via ava.

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 ava. To run the unit tests, execute npm run 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.

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.