Renuo-cms-client NPM

Renuo CMS Client Script

Usage, Architecture and Documentation

See https://renuo.gitbooks.io/renuo-cms-doc/content/

Renuo CMS API

This project works with any backend implementing the correct API. https://github.com/renuo/renuo-cms-api is a reference implementation for such a server.

Development

Installation

Prerequisites

Install https://github.com/creationix/nvm
Install https://github.com/rbenv/rbenv
Install https://github.com/yyuu/pyenv

git clone git@github.com:renuo/renuo-cms-client.git
cd renuo-cms-client
bin/setup && bin/check

Commands Summary

# run tests and linting
bin/check
# local development
gulp tdd
# manual testing in the browser
# also compiles everything into .tmp/renuo-cms-client.js, which will be used in local testing
# .tmp/renuo-cms-client.js should be minified for a release
gulp serve
# generates dist/renuo-cms-client.js
gulp dist
# clean all
gulp clean-all
# single test run
gulp test
# run tests in multiple browsers
MULTIPLE_BROWSERS=1 gulp test

Important URLs

Dependencies / Type Definitions

Install a new dependency (e.g. jquery):

typings install jquery --ambient --save

Reinstall dependencies:

typings install

Tests

We use TDD:

gulp tdd

This will test the app with PhantomJS:

gulp test

To test the code in additional browsers (Chrome and Firefox):

MULTIPLE_BROWSERS=1 gulp test

Release

bundle exec ruby release.rb

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/renuo-cms-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.