1 # Corpus CMS

     2 

     3 This README describes how to generate a Drupal module embedding a ember app.

     4 

     5 ## Prerequisites

     6 

     7 You will need the following things properly installed on your computer.

     8 

     9 * [Node.js](http://nodejs.org/) (with NPM)

    10 

    11 ## Installation

    12 

    13 * `npm install --prefix app-client/` (install the dependencies of the ember app)

    14 * `npm install`

    15 

    16 ### Building

    17 

    18 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:

    19 

    20 * `npm run build`

    21 

    22 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.

    23 

    24 ### Deploy

    25 

    26 Once the module has been updated with the correct built app, you can compress it and share it.

    27 To include the compressed module to a Drupal website, simply unzip the module and place it in the modules/ folder in your Drupal project.

    28 Report to the README inside the module folder for further informations.