Skip to content

Commit 0fb25b6

Browse files
committed
Use Yarn/NPM to run Gulp
No need to have Gulp installed globaly
1 parent 1595c09 commit 0fb25b6

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
{
22
"name": "pim-api-docs",
3+
"scripts": {
4+
"serve": "gulp serve"
5+
},
36
"dependencies": {
47
"jquery": "3.1.1",
58
"font-awesome": "4.7.0",

readme.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,32 @@ The API documentation can be found here: [api.akeneo.com](http://api.akeneo.com)
66
## Installation for dev/preview purposes
77

88
### Requirements
9-
[Node](https://nodejs.org/en/) is required and [Gulp-cli](https://github.com/gulpjs/gulp-cli) as well.
9+
[Node.js](https://nodejs.org/en/) is required.
10+
You can optionally choose [Yarn](https://yarnpkg.com/lang/en/) as package manager instead of NPM (provided with NodeJS by default).
11+
12+
### Run locally
13+
First, install the all dependencies with Yarn:
1014

1115
```bash
12-
sudo npm install --global n
13-
sudo n 7.2.0
14-
npm install
15-
sudo npm install --global gulp-cli
16+
yarn install
1617
```
1718

18-
### Run locally
19-
Once Node and gulp-cli installed, run:
19+
or with NPM:
2020

2121
```bash
2222
npm install
23+
```
24+
25+
Then run the Gulp server, with Yarn:
2326

24-
gulp serve
27+
```bash
28+
yarn serve
29+
```
30+
31+
or with NPM:
32+
33+
```bash
34+
npm serve
2535
```
2636

2737
The API documentation site is then available on `localhost:8000`.

0 commit comments

Comments
 (0)