Skip to content

Commit e16acc1

Browse files
committed
Development & unit testing instructions added.
1 parent aac2a27 commit e16acc1

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,36 @@ Want to contribute?
7272
1. Fork this repository and clone it.
7373
2. Create a branch from develop: `git checkout -b feature-foo`.
7474
3. Push your commits and create a pull request.
75+
76+
Setting up development environment
77+
----------------------------------
78+
79+
**Prerequisites:**
80+
81+
You need to have installed the following softwares.
82+
83+
- Composer.
84+
- NodeJS.
85+
- NPM.
86+
- PHP 5.4+.
87+
88+
After getting all the required softwares you may run the following commands to get everything ready:
89+
90+
1. Install PHP dependencies:
91+
92+
composer install
93+
94+
2. Install NPM dependences:
95+
96+
npm install
97+
98+
Now you are good to go! Happy coding!
99+
100+
Unit testing
101+
------------
102+
103+
This project use Node-Jasmine as the test runner. All tests are stored at `tests/spec` directory.
104+
105+
To run all tests type in you terminal:
106+
107+
npm test

0 commit comments

Comments
 (0)