Commit 50d18589f6c6560c7875cc31296b6075e7656e03
Committed by
Carlos Coêlho
Carlos Coêlho
1 parent
697684e6
Exists in
master
change README install instructions
(cherry picked from commit d2b6b43f7d6e60350491a1337853ba4fd5f3efb0)
Showing
1 changed file
with
14 additions
and
1 deletions
Show diff stats
README.md
| @@ -4,12 +4,25 @@ The Noosfero theme that uses the API to create a totally new client-side fronten | @@ -4,12 +4,25 @@ The Noosfero theme that uses the API to create a totally new client-side fronten | ||
| 4 | 4 | ||
| 5 | ## Getting started | 5 | ## Getting started |
| 6 | 6 | ||
| 7 | +### If you use Vagrant | ||
| 8 | +Use our [VirtualBox](https://atlas.hashicorp.com/paulohtfs/boxes/noosfero-dev) with everything setup. | ||
| 9 | +Run: | ||
| 10 | +``` | ||
| 11 | + vagrant init paulohtfs/noosfero-dev | ||
| 12 | + vagrant up --provider virtualbox | ||
| 13 | + vagrant ssh | ||
| 14 | +``` | ||
| 15 | +This box provides Noosfero and the Angular base theme repositories. | ||
| 16 | +We've also set up vim and tmux to make the work easier. | ||
| 17 | + | ||
| 7 | ### How to Install | 18 | ### How to Install |
| 8 | 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) | 19 | 1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) |
| 9 | 1. Install [Bower](http://bower.io/): `npm install -g bower` | 20 | 1. Install [Bower](http://bower.io/): `npm install -g bower` |
| 21 | +1. Install [Gulp](http://gulpjs.com/): `npm install -g gulp` | ||
| 10 | 1. Install Node.js dependencies: `npm install` | 22 | 1. Install Node.js dependencies: `npm install` |
| 11 | 1. Install bower dependencies: `bower install` | 23 | 1. Install bower dependencies: `bower install` |
| 12 | -1. Build the project: `gulp build` | 24 | +1. Build the project: `npm run build` |
| 25 | +1. Run project tests: `npm run test` | ||
| 13 | 26 | ||
| 14 | ### How to Use | 27 | ### How to Use |
| 15 | 28 |