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: docs/setup.md
+15-55Lines changed: 15 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,7 @@ the GUAC services. It acts as a way to visualize the software supply chain graph
7
7
as well as a means to explore the supply chain, and prototype policies.
8
8
9
9
Since the GUAC Visaulizer is still in an early experimental stage, it is likely
10
-
that there may be some unexpected behavior or usage problems. For a more robust
11
-
use of GUAC, we recommend using the [GraphQL interface directly](https://github.com/guacsec/guac/blob/main/demo/GraphQL.md).
10
+
that there may be some unexpected behavior or usage problems. We recommend using the [GraphQL interface directly](https://github.com/guacsec/guac/blob/main/demo/GraphQL.md). Feedback is welcome as we continue to improve the visualizer!
12
11
13
12
## Requirements
14
13
@@ -22,83 +21,44 @@ use of GUAC, we recommend using the [GraphQL interface directly](https://github.
22
21
To use the GUAC visualizer, you need to have the main GUAC server running. For more information on how to do this, click
23
22
[here](https://docs.guac.sh/getting-started/).
24
23
25
-
## Getting started
24
+
## Step 1. Getting started
26
25
27
-
If you already haven't, clone the GUAC visualizer repo. We highly suggest
28
-
cloning it in the same path as you clone the main
29
-
[GUAC repo](https://github.com/guacsec/guac).
26
+
Get the
27
+
[source code for guac-visualizer `v0.3.0` here:](https://github.com/guacsec/guac-visualizer/releases/tag/v0.3.0)
All commands run throughout this guide should be in this working directory.
42
-
43
-
## Running the visualizer from source
44
-
45
-
Install the dependencies:
35
+
## Step 2. Install dependencies
46
36
47
37
```bash
48
38
yarn install
49
39
```
50
40
51
-
The output should look like:
52
-
53
-
````
54
-
$ yarn install
55
-
yarn install v1.22.19
56
-
warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.
57
-
[1/4] 🔍 Resolving packages...
58
-
[2/4] 🚚 Fetching packages...
59
-
warning Pattern ["@apollo/client@latest"] is trying to unpack in the same destination "/Users/lumb/Library/Caches/Yarn/v6/npm-@apollo-client-3.7.12-9ddd355d0788374cdb900e5f40298b196176952b-integrity/node_modules/@apollo/client" as pattern ["@apollo/client@^3.7.10"]. This could result in non-deterministic behavior, skipping.
1.1.6" has incorrect peer dependency "react-scripts@>=2.1.8 <=3.4.1".
68
-
[4/4] 🔨 Building fresh packages...
69
-
70
-
success Saved lockfile.
71
-
✨ Done in 28.68s.
72
-
````
73
-
74
-
## Configuration
75
-
76
-
By default, the GUAC Visualizer assumes that the GraphQL server is running on http://localhost:8080/query. However, you can optionally configure the visualizer to connect to a different GraphQL endpoint or to read from a `guac.yaml` config file from your curent working directory.
77
-
78
-
## Running the visualizer locally:
41
+
## Step 3. Run the visualizer locally:
79
42
80
43
```bash
81
44
yarn dev
82
45
```
83
46
84
-
The output should look like:
47
+
You can then go to [localhost:3000](http://localhost:3000) in your browser to
48
+
start using the visualizer.
85
49
86
50
```
87
-
$ yarn dev
88
-
yarn run v1.22.19
51
+
...
52
+
89
53
$ next dev
90
54
ready - started server on 0.0.0.0:3000, url: http://localhost:3000
91
55
info - Using webpack 5. Reason: Enabled by default https://nextjs.org/docs/messages/webpack5
92
-
```
93
56
94
-
You can then go to [localhost:3000](http://localhost:3000) in your browser to
95
-
see the graph visualization.
57
+
...
58
+
```
96
59
97
60
<hr />
98
-
<br />
99
-
100
-
### Using the GUAC visualizer will look something like this:
101
61
102
-
<br />
62
+
**Using the GUAC visualizer will look something like this:**
0 commit comments