diff -r ba32dd4cf8d3 -r 10f67f0281e1 cms/README.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/cms/README.md Fri Nov 13 11:02:22 2015 +0100 @@ -0,0 +1,28 @@ +# Corpus CMS + +This README describes how to generate a Drupal module embedding a ember app. + +## Prerequisites + +You will need the following things properly installed on your computer. + +* [Node.js](http://nodejs.org/) (with NPM) + +## Installation + +* `npm install --prefix app-client/` (install the dependencies of the ember app) +* `npm install` + +### Building + +To build the module, you need to build the ember app then to copy the correct files into the modules folder. It can easily be done by the following command line: + +* `npm run build` + +It will first run `npm run build --prefix app-client` which will build the ember app, and then run `gulp copy-module` to copy the built files into the module folder. + +### Deploy + +Once the module has been updated with the correct built app, you can compress it and share it. +To include the compressed module to a Drupal website, simply unzip the module and place it in the modules/ folder in your Drupal project. +Report to the README inside the module folder for further informations.