You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-16Lines changed: 23 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,27 +38,34 @@ API documentation is available at [http://workfront.github.io/workfront-api/](ht
38
38
A number of examples can be found under [examples](examples) directory. It includes examples for both [node](examples/node) and [browser](examples/browser) environments.
39
39
In order to run these examples clone a copy of workfront-api repository:
First enter into `workfront-api` directory and install all the dependencies:
46
48
47
-
48
-
cd workfront-api
49
-
npm install
49
+
```
50
+
cd workfront-api
51
+
yarn
52
+
```
50
53
51
54
Use `node` to run the examples. For examples:
52
55
53
-
node examples/node/get-user-count.js
56
+
```
57
+
node examples/node/get-user-count.js
58
+
```
54
59
55
60
Each example script outputs all its results into console and contains comments in the source code explaining what is happening in more details.
56
61
57
62
#### Running [browser](examples/browser) examples
58
63
59
64
To start supplied webserver type:
60
65
61
-
npm start
66
+
```shell script
67
+
npm start
68
+
```
62
69
63
70
Visit [http://localhost:8000/examples/browser/](http://localhost:8000/examples/browser/) to see list of all examples available for browser.
64
71
@@ -70,11 +77,11 @@ We welcome contributions of all kinds from anyone. It can be either new example
70
77
71
78
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you! Please make sure to check these points to make a good bug report:
72
79
73
-
1.**Use the GitHub issue search**— check if the issue has already been
74
-
reported.
75
-
2.**Isolate the problem**— ideally create a [reduced test
0 commit comments