Skip to content

Commit

Permalink
Improve install instructions of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
olafveerman committed Jun 19, 2014
1 parent 2be40a4 commit ab00d99
Showing 1 changed file with 34 additions and 25 deletions.
59 changes: 34 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,21 @@ Built using [Codeigniter](http://ellislab.com/codeigniter)

## Team
Daniel da Silva - [Github](https://github.com/danielfdsilva)
Ricardo Mestre - [Github](https://github.com/ricardomestre)
Olaf Veerman - [Github](https://github.com/olafveerman)
Nuno Veloso - [Github](https://github.com/nunoveloso)
Ricardo Mestre - [Github](https://github.com/ricardomestre)

___

## Development environment
To ease development everything was bundled in a vagrant box. To setup the vagrant box check out the [instructions in the wiki](https://github.com/flipside-org/aw-datacollection/wiki/Vagrant-box).
To ease development, everything was bundled in a vagrant box. To set it up, simply run ```vagrant up``` from the root of the project. For more details about the Vagrant box and useful commands, check out the [instructions in the wiki](https://github.com/flipside-org/aw-datacollection/wiki/Vagrant-box).

If you want to develop locally without using the vagrant box, check the [local development section](https://github.com/flipside-org/aw-datacollection/wiki/Local-development) for the needed dependencies.

If you want to develop locally, without using the vagrant box, check the [local development section](https://github.com/flipside-org/aw-datacollection/wiki/Local-development) for the needed dependencies.

### Requirements
These dependencies are needed to build the app no matter whether you use the Vagrant box or manually set up the environment:

## Requirements
These dependencies and setup are needed to build the app no matter the development environment you choose to use, and must be done on your machine.
- Node & Npm
- Grunt ( $ npm install -g grunt-cli )
- Bower ($ npm install -g bower)
Expand All @@ -47,36 +48,18 @@ The enketo library needs to be built:
```
$ cd assets/libs/enketo-core
$ npm install
$ grunt
$ grunt --force
```
Patch pyxform library, from the app root folder:
```
$ git apply --directory=application/third_party/pyxform/ pyxform_validate_and_constants.patch
```
___

## Getting started
```
$ grunt
```
Compiles the compass files, javascript and generates the website.
The system will watch files and execute tasks whenever one of them changes.
Build the CSS and Javascript, from the root folder of the

### Other commands
Clean the compiled sass and javascript:
```
$ grunt clean
```

Compile the compass files, javascript and generate the website. Use this instead of ```grunt``` if you just want to render it once:
```
$ grunt build
```

Compile the compass files and javascripts prepared for production (minified, uglyfied). Every time changes will be pushed to production, this command needs to be run:
```
$ grunt prod
```
___

## First run
Expand All @@ -97,6 +80,32 @@ This will give you 2 options to setup the application:
After this setup, change the environment to *production* on ```index.php```
___

## Build automation
Grunt is used for the build automation.

```
$ grunt
```
Compiles the compass files, javascript and generates the website.
The system will watch files and execute tasks whenever one of them changes.

### Other commands
Clean the compiled sass and javascript:
```
$ grunt clean
```

Compile the compass files, javascript and generate the website. Use this instead of ```grunt``` if you just want to render it once:
```
$ grunt build
```

Compile the compass files and javascripts prepared for production (minified, uglyfied). Every time changes will be pushed to production, this command needs to be run:
```
$ grunt prod
```
___

## Testing
Testing is done using phpunit. To run the tests you just need to run ```phpunit``` in the app's root folder.
If you're using the Vagrant box environment be sure to do this inside the vagrant machine.

0 comments on commit ab00d99

Please sign in to comment.