Update README
parent
7c6288f49b
commit
8efbc201bc
48
README.md
48
README.md
|
@ -11,7 +11,11 @@ You can get the compiled version of this code in the
|
||||||
[taiga-front-dist](http://github.com/taigaio/taiga-front-dist) repository
|
[taiga-front-dist](http://github.com/taigaio/taiga-front-dist) repository
|
||||||
|
|
||||||
|
|
||||||
## Setup initial environment ##
|
## Setup ##
|
||||||
|
|
||||||
|
All the information about the different installation methods (production, development, vagrant, docker...) can be found here http://taigaio.github.io/taiga-doc/dist/#_installation_guide.
|
||||||
|
|
||||||
|
### Initial dev env ###
|
||||||
|
|
||||||
Install requirements:
|
Install requirements:
|
||||||
|
|
||||||
|
@ -21,31 +25,44 @@ You can install Ruby through the apt package manager, rbenv, or rvm.
|
||||||
Install Sass through your **Terminal or Command Prompt**.
|
Install Sass through your **Terminal or Command Prompt**.
|
||||||
|
|
||||||
```
|
```
|
||||||
$ gem install sass scss-lint
|
gem install sass scss-lint
|
||||||
$ export PATH="~/.gem/ruby/2.1.0/bin:$PATH"
|
export PATH="~/.gem/ruby/2.1.0/bin:$PATH"
|
||||||
$ sass -v // should return Sass 3.3.8 (Maptastic Maple)
|
sass -v # should return Sass 3.3.8 (Maptastic Maple)
|
||||||
```
|
```
|
||||||
|
|
||||||
Complete process for all OS at: http://sass-lang.com/install
|
Complete process for all OS at: http://sass-lang.com/install
|
||||||
|
|
||||||
**Node + Bower + Gulp**
|
**Node + Bower + Gulp**
|
||||||
|
|
||||||
|
We recommend to use [nvm](https://github.com/creationix/nvmv) to manege diferent node versions
|
||||||
```
|
```
|
||||||
$ sudo npm install -g gulp
|
npm install -g gulp
|
||||||
$ sudo npm install -g bower
|
npm install -g bower
|
||||||
$ npm install
|
npm install
|
||||||
$ bower install
|
bower install
|
||||||
$ gulp
|
gulp
|
||||||
```
|
```
|
||||||
|
|
||||||
And go in your browser to: http://localhost:9001/
|
And go in your browser to: http://localhost:9001/
|
||||||
|
|
||||||
All the information about the different installation methods (production, development, vagrant, docker...) can be found here http://taigaio.github.io/taiga-doc/dist/#_installation_guide.
|
### E2E test ###
|
||||||
|
|
||||||
|
If you want to run e2e tests
|
||||||
|
|
||||||
## Run tests ##
|
```
|
||||||
|
npm install -g protractor
|
||||||
|
npm install -g mocha
|
||||||
|
npm install -g babel
|
||||||
|
|
||||||
|
webdriver-manager update
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tests ##
|
||||||
|
|
||||||
|
### Unit tests ###
|
||||||
|
|
||||||
- To run **unit tests**
|
- To run **unit tests**
|
||||||
|
|
||||||
```
|
```
|
||||||
gulp
|
gulp
|
||||||
```
|
```
|
||||||
|
@ -53,9 +70,14 @@ All the information about the different installation methods (production, develo
|
||||||
npm test
|
npm test
|
||||||
```
|
```
|
||||||
|
|
||||||
- To run **e2e tests**
|
### E2E tests ###
|
||||||
|
|
||||||
|
- To run **e2e tests** you need [taiga-back](https://github.com/taigaio/taiga-back) running and
|
||||||
|
|
||||||
|
```
|
||||||
|
gulp
|
||||||
|
```
|
||||||
```
|
```
|
||||||
webdriver-manager update # Only the first time
|
|
||||||
webdriver-manager start
|
webdriver-manager start
|
||||||
```
|
```
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in New Issue