Nick is a (nearly) headless CMS written in Node.js which provides a RESTful hypermedia API. The API is compatible with the REST API of the Plone CMS and can be used together with the web frontend Volto.
A live demo of Nick with the latest release is available at:
Example GET request on the portal root
curl -i https://demo.nickcms.org -H "Accept: application/json"
$ CREATE DATABASE nick;
$ CREATE USER nick WITH ENCRYPTED PASSWORD 'nick';
$ GRANT ALL PRIVILEGES ON DATABASE nick TO nick;
$ yarn bootstrap
$ yarn start
$ yarn test
If you want to create your own project and use Nick as a dependency you can use the Yeoman generator package for that. This way you are able to customize your project without making changes to the core of Nick.
First, install Yeoman and @robgietema/generator-nick using npm (we assume you have pre-installed node.js).
$ npm install -g yo
$ npm install -g @robgietema/generator-nick
$ yo @robgietema/nick my-nick-project
This will bootstrap a new Nick project inside the current folder.
Create a database and a user with the correct permissions for your project (see above for details) and then bootstrap Nick with:
$ cd my-nick-project
$ yarn bootstrap
$ yarn start
- Issue tracker: https://github.com/robgietema/nick/issues
- Source Code: https://github.com/robgietema/nick
- Documentation https://docs.nickcms.org
If you are having issues, please let us know via the issue tracker.
MIT License. Copyrights hold Rob Gietema. See LICENSE.md for details.