This is the main repo for the prototype web-based CAT tool developed at CNGL.

#Build Instructions

The frontend is build entirely with javascript, using the Angular framework.

To set up your development environment, it's strongly recommended that you use the development stack consisting of:

• bower - for frontend package management
• grunt - for automating the build and deployment, running tests, and providing the development server (using packages from npm)
• npm - for managing the node js dependencies

1. Install node and npm if you don't already have them.

• you shouldn't need to use sudo, the scripts here are good installation options.
• if you already have node and npm, don't try to install again without completely getting rid of your previous installation.
• in order to compile node in a fresh Ubuntu instalation you'll need to install the C/C++ compilation tools first. sudo apt-get install build-essential will install them.
• the scripts also require curl: sudo apt-get install curl

2. clone the repo git clone [email protected]:CNGL-repo/editor_components.git
3. install grunt npm install -g grunt
4. install grun-cli npm install -g grunt-cli
5. install boew npm install -g bower
6. run $ npm install from the top directiory(editor_components/)
7. run $ bower install from the top directory(editor_components/)
8. build bootstrap ui -

$ cd app/bower_components/angular-ui-bootstrap
$ npm install
$ grunt

5. to use the autoreload and watch changes functionalities, you'll need ruby and compass.

• install Ruby, then do gem install compass
• make sure that your ruby installation's bin/ folder is on your $PATH

Finally, once you've done all that, you should be able to run grunt express-server, and fire up a server which watches all of the files in the repo, and automagically reloads whenever you change something.

The command was previously grunt serve, but this was changed so that both the server and the UI reload automagically.

• use two spaces to indent javascript

• the project uses sass and makes use of mixins and css variables in the app/styles/ directory
• you need at least sass 3.3 -- do sass -v to check your version, gem install sass to install/update

• to start the server to the glossary and concordancer endpoints, do:

  cd server/     
  node web.js
  

• if you're getting an error in the grunt build process, do grunt <your_command> --force --verbose and look through the output to see what might be causing the problem.

• The command grunt build will build the client application into dist/