Skip to content

Commit f25656a

Browse files
committed
Added quick start guide
1 parent 2963e4b commit f25656a

File tree

2 files changed

+140
-0
lines changed

2 files changed

+140
-0
lines changed

docs/video.svg

Lines changed: 82 additions & 0 deletions
Loading

getting_started/quick_start.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# OASGraph Quickstart
2+
3+
## Video demo
4+
5+
[![Video demo](../docs/video.svg)](https://www.youtube.com/watch?v=_u7artgCqAw&feature=youtu.be)
6+
7+
## Write up
8+
9+
### Start API server
10+
11+
In your LoopBack application, run the following command.
12+
13+
```
14+
npm start
15+
```
16+
17+
***
18+
19+
Or boot up whichever backend that supports your API.
20+
21+
### Save the OAS
22+
23+
In your Loopback application, go [here](http://localhost:3000/openapi.json).
24+
25+
***
26+
27+
Or get whichever OAS you would like to use.
28+
29+
30+
### Clone OASGraph
31+
32+
You can find the repository [here](https://github.com/strongloop/oasgraph).
33+
34+
```
35+
git clone [email protected]:strongloop/oasgraph.git
36+
```
37+
38+
### Create CLI tool
39+
40+
Go into the OASGraph directory...
41+
42+
```
43+
cd oasgraph
44+
```
45+
46+
... and build the CLI tool.
47+
48+
```
49+
npm link
50+
```
51+
52+
### Start GraphQL server
53+
54+
```
55+
oasgraph [OAS path]
56+
```
57+
58+
To see your GraphQL server, go [here](http://localhost:3001/graphql).

0 commit comments

Comments
 (0)