Skip to content

Commit b0b6771

Browse files
authored
Merge pull request #175 from rakutentech/kevincobain2000-patch-1
Update README.md
2 parents 44b4c30 + 572d31f commit b0b6771

File tree

1 file changed

+42
-7
lines changed

1 file changed

+42
-7
lines changed

ui/README.md

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
# Notes
22

3-
### Local UI Development
4-
3+
## Local UI Development
54

65
```
6+
cd ui/
77
npm install
88
npm run dev
99
```
1010

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
1216

1317

14-
### Developing with Laravel
18+
## 2) Mode: Developing with Laravel via npm
1519

16-
#### Step 1
20+
**Step 1**
1721

1822
**Optional** Enable CORS on Laravel to allow localhost:3000/request-docs
23+
1924
**Recommended** Open Chrome with `--disable-web-security` flag
2025

2126
On Mac to open chrome command:
@@ -25,11 +30,41 @@ open -n -a /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --args
2530
```
2631

2732

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
2864

29-
#### Step 2
3065

31-
**Open in Browser** http://localhost:3000?api=http://localhost:8000/request-docs/api
3266

67+
---
3368

3469
## Deployment notes
3570

0 commit comments

Comments
 (0)