Skip to content

Commit 71d1b54

Browse files
authored
Update sample-app.md
1 parent 30e1207 commit 71d1b54

File tree

1 file changed

+24
-27
lines changed

1 file changed

+24
-27
lines changed

Diff for: docs/sample-app.md

+24-27
Original file line numberDiff line numberDiff line change
@@ -6,62 +6,59 @@ sidebar_position: 7
66

77
[This](https://github.com/laravel-workflow/sample-app) is a sample Laravel 12 application with example workflows that you can run inside a GitHub codespace.
88

9-
<br />
9+
### Step 1
10+
Create a codespace from the main branch of this repo.
1011

11-
**Step 1**
12+
<img src="https://user-images.githubusercontent.com/1130888/233664377-f300ad50-5436-4bb8-b172-c52e12047264.png" alt="image" width="300">
1213

13-
Create a codespace from the main branch of [this](https://github.com/laravel-workflow/sample-app) repo.
14+
### Step 2
15+
Once the codespace has been created, wait for the codespace to build. This should take between 5 to 10 minutes.
1416

15-
<img src="https://user-images.githubusercontent.com/1130888/233664377-f300ad50-5436-4bb8-b172-c52e12047264.png" alt="image" width="300" />
1617

17-
**Step 2**
18+
### Step 3
19+
Once it is done. You will see the editor and the terminal at the bottom.
1820

19-
Wait for the codespace to build. This should take between 5 to 10 minutes. Once the codespace has been created. You will see the editor and the terminal at the bottom.
21+
<img src="https://user-images.githubusercontent.com/1130888/233665550-1a4f2098-2919-4108-ac9f-bef1a9f2f47c.png" alt="image" width="400">
2022

21-
<img src="https://user-images.githubusercontent.com/1130888/233665550-1a4f2098-2919-4108-ac9f-bef1a9f2f47c.png" alt="image" width="400" />
23+
### Step 4
24+
Run composer install.
2225

23-
**Step 3**
26+
```bash
27+
composer install
28+
```
2429

25-
Run the migrations to create the necessary database tables.
30+
### Step 5
31+
Run the init command to setup the app, install extra dependencies and run the migrations.
2632

2733
```bash
28-
php artisan migrate
34+
php artisan app:init
2935
```
3036

31-
**Step 4**
32-
37+
### Step 6
3338
Start the queue worker. This will enable the processing of workflows and activities.
3439

3540
```bash
3641
php artisan queue:work
3742
```
3843

39-
**Step 5**
40-
44+
### Step 7
4145
Create a new terminal window.
4246

43-
<img src="https://user-images.githubusercontent.com/1130888/233666917-029247c7-9e6c-46de-b304-27473fd34517.png" alt="image" width="200" />
44-
45-
**Step 6**
47+
<img src="https://user-images.githubusercontent.com/1130888/233666917-029247c7-9e6c-46de-b304-27473fd34517.png" alt="image" width="200">
4648

49+
### Step 8
4750
Start the example workflow inside the new terminal window.
4851

4952
```bash
5053
php artisan app:workflow
5154
```
5255

53-
**Step 7**
54-
55-
You can view the waterline dashboard via the mapped port.
56-
57-
<img src="https://user-images.githubusercontent.com/1130888/233668485-b988e336-0462-4bbc-bb77-78c73df363b4.png" alt="image" width="500" />
58-
59-
Add `/waterline/dashboard` to the URL e.g. `https://[your-codespace-name]-80.preview.app.github.dev/waterline/dashboard`
60-
61-
<img src="https://user-images.githubusercontent.com/1130888/233669600-3340ada6-5f73-4602-8d82-a81a9d43f883.png" alt="image" width="600" />
56+
### Step 9
57+
You can view the waterline dashboard at https://[your-codespace-name]-80.preview.app.github.dev/waterline/dashboard.
6258

63-
**Step 8**
59+
<img src="https://user-images.githubusercontent.com/1130888/233669600-3340ada6-5f73-4602-8d82-a81a9d43f883.png" alt="image" width="600">
6460

61+
### Step 10
6562
Run the workflow and activity tests.
6663

6764
```bash

0 commit comments

Comments
 (0)