File tree Expand file tree Collapse file tree 2 files changed +21
-8
lines changed Expand file tree Collapse file tree 2 files changed +21
-8
lines changed Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " pim-api-docs" ,
3
+ "scripts" : {
4
+ "serve" : " gulp serve"
5
+ },
3
6
"dependencies" : {
4
7
"jquery" : " 3.1.1" ,
5
8
"font-awesome" : " 4.7.0" ,
Original file line number Diff line number Diff line change @@ -6,22 +6,32 @@ The API documentation can be found here: [api.akeneo.com](http://api.akeneo.com)
6
6
## Installation for dev/preview purposes
7
7
8
8
### 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:
10
14
11
15
``` 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
16
17
```
17
18
18
- ### Run locally
19
- Once Node and gulp-cli installed, run:
19
+ or with NPM:
20
20
21
21
``` bash
22
22
npm install
23
+ ```
24
+
25
+ Then run the Gulp server, with Yarn:
23
26
24
- gulp serve
27
+ ``` bash
28
+ yarn serve
29
+ ```
30
+
31
+ or with NPM:
32
+
33
+ ``` bash
34
+ npm serve
25
35
```
26
36
27
37
The API documentation site is then available on ` localhost:8000 ` .
You can’t perform that action at this time.
0 commit comments