CourseAdvisor

Setup

This section describes how to setup a development environment.

Requirements

• A web server running php
• A php cli ( php5-cli on debian )
• nodejs + npm
• gulp (npm install -g gulp)

Step-by-step

1. clone the repository
2. In the repository folder download composer.phar curl -sS https://getcomposer.org/installer | php
3. run npm install
4. publish the assets using gulp publish
5. configure your database (see below)

Database configuration

cp app/config/database.php app/config/production/database.php Enter your database specific configuration in app/config/production/database.php

Troubleshooting

During npm install

If you get:

Mcrypt PHP extension required.
Script php artisan clear-compiled handling the post-install-cmd event returned with an error

run:

sudo apt-get install php5-mcrypt
sudo php5enmod mcrypt

If you get:

php: command not found

run:

sudo apt-get install php5-cli

Documentation

Laravel

Documentation for the entire framework can be found on the Laravel website. All issues and pull requests should be filed on the laravel/framework repository. The Laravel framework is open-sourced software licensed under the MIT license

Testing

To tests authenticated features, we are using margarita. Run ./test.sh --setup-margarita to install a local copy of margarita, then in app/config/production/tequila.php, add 'server_url' => 'http://localhost:3000/'

Integration tests are run with casperjs. Install phantomjs v1.8.x (not 2.x !!!), install casperjs and make sure both are available in the path. API tests use frisbyjs. Both kind of tests use a few utilities to hide some of the boilerplate. More information can be found in tests/(api|integration)/utils.coffee

You can then run the tests with ./test.sh -m -s. For a full list of available test options, run ./test.sh --help.

Gulp tasks

All front-end related files go into assets/. This file is not served over http. Instead, gulp tasks take care to compile/minify/bake/whatever your files and put them in the public/ folder.

gulp watch (default)

This task will watch for changes in the assets/ dir and update the public/ dir accordingly

gulp publish

Publishes everything into the public/ folder. Assets that must be compiled are compiled by the way.

gulp clean

Cleans the public/ directory. This selectively removes generated files from public/ (It is not equivalent to rm -rf public/ and this command should not be run).

artisan commands

php artisan ide-helper:generate

Generates a file for IDE autocompletion and stuff. Works well with phpstorm for instance.