File tree Expand file tree Collapse file tree 1 file changed +42
-7
lines changed Expand file tree Collapse file tree 1 file changed +42
-7
lines changed Original file line number Diff line number Diff line change 1
1
# Notes
2
2
3
- ### Local UI Development
4
-
3
+ ## Local UI Development
5
4
6
5
```
6
+ cd ui/
7
7
npm install
8
8
npm run dev
9
9
```
10
10
11
- ** Open in Browser** http://localhost:3000/request-docs?api=http://localhost:3000/request-docs/sample.json
11
+ ## 1) Mode: Readonly
12
+
13
+ ** Open in Browser**
14
+
15
+ http://localhost:3000/request-docs?api=http://localhost:3000/request-docs/sample.json
12
16
13
17
14
- ### Developing with Laravel
18
+ ## 2) Mode: Developing with Laravel via npm
15
19
16
- #### Step 1
20
+ ** Step 1**
17
21
18
22
** Optional** Enable CORS on Laravel to allow localhost:3000/request-docs
23
+
19
24
** Recommended** Open Chrome with ` --disable-web-security ` flag
20
25
21
26
On Mac to open chrome command:
@@ -25,11 +30,41 @@ open -n -a /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --args
25
30
```
26
31
27
32
33
+ ** Step 2**
34
+
35
+ ** Open in Browser** http://localhost:3000/request-docs?api=http://localhost:8000/request-docs/api
36
+
37
+
38
+ ## 3) Mode: Developing with Laravel via Laravel
39
+
40
+
41
+
42
+ Add to composer.json
43
+
44
+ ``` sh
45
+ " repositories" : [
46
+ {
47
+ " type" : " path" ,
48
+ " url" : " /Users/yourpath/to/laravel-request-docs"
49
+ }
50
+ ],
51
+
52
+ ```
53
+
54
+ ``` sh
55
+ composer require rakutentech/laravel-request-docs @dev
56
+ ```
57
+
58
+ ```
59
+ cd ui
60
+ npm run export
61
+ ```
62
+
63
+ ** Open in Browser** http://localhost:8000/request-docs
28
64
29
- #### Step 2
30
65
31
- ** Open in Browser** http://localhost:3000?api=http://localhost:8000/request-docs/api
32
66
67
+ ---
33
68
34
69
## Deployment notes
35
70
You can’t perform that action at this time.
0 commit comments