Skip to content

Commit

Permalink
Updates README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Silva committed Feb 11, 2014
1 parent 4f70fb8 commit 2bc1fa3
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,47 @@ Built using [Codeigniter](http://ellislab.com/codeigniter)
- Apache
- PHP 5.3
- MongoDB
- Node & Npm
- Grunt

`@todo`


## Setup
**This is to be done in the local machine, not on vagrant**

After cloning the repository, setup the public files directory and its subfolders at the root of the app:
```
$ mkdir -p files/surveys
$ chmod -R 777 files
```

Update git submodules (**This should be also done after pulling changes**):
```
$ git submdodule --init --recursive
```
The enketo library needs to be built. Change into its directory:
```
$ cd assets/libs/enketo-core/
$ npm install
$ grunt
```

## Running
**Temporary**  
The aw-datacollection app requires mongo.  
Ssh into the vagrant machine and start mongo.
```
$ vagrant ssh
$ mongod
```

## Testing
Testing is being done with phpunit.
There isn't a seamless way to integrate codeigniter and phpunit. To allow fully integration, two changes must be done to core.
Testing is being done with phpunit.  

`@todo Explain how to work with this and move explanation.`

There isn't a seamless way to integrate codeigniter and phpunit. To allow fully integration, two changes must be done to core.
Check https://github.com/fmalk/codeigniter-phpunit for more.

The "TOAST - Unit Testing for CodeIgniter" was also tried but it isn't as powerful as phpunit. TOAST has a controller that only implements some methods that are available by default on phpunit. Also TOAST requires files (views, controllers) to be side by side with the application while phpunit can be separated.
The "TOAST - Unit Testing for CodeIgniter" was also tried but it isn't as powerful as phpunit. TOAST has a controller that only implements some methods that are available by default on phpunit. Also TOAST requires files (views, controllers) to be side by side with the application while phpunit can be separated.

0 comments on commit 2bc1fa3

Please sign in to comment.