cms/README.md
author nowmad@nowmads-macbook-pro.local
Thu, 10 Dec 2015 16:57:59 +0100
changeset 46 b9afefcfe964
parent 14 10f67f0281e1
child 104 bd3747a1cd5f
permissions -rw-r--r--
create carto route to try a query and render the carto compoenent in a specific outlet
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     1
# Corpus CMS
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     2
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     3
This README describes how to generate a Drupal module embedding a ember app.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     4
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     5
## Prerequisites
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     6
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     7
You will need the following things properly installed on your computer.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     8
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
     9
* [Node.js](http://nodejs.org/) (with NPM)
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    10
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    11
## Installation
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    12
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    13
* `npm install --prefix app-client/` (install the dependencies of the ember app)
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    14
* `npm install`
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    15
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    16
### Building
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    17
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    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:
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    19
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    20
* `npm run build`
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    21
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    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.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    23
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    24
### Deploy
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    25
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    26
Once the module has been updated with the correct built app, you can compress it and share it.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    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.
10f67f0281e1 move the gulpfile in the cms folder instead of the app - add readme for module and cms
nowmad@23.1.168.192.in-addr.arpa
parents:
diff changeset
    28
Report to the README inside the module folder for further informations.