Skip to content

Commit 8d50a05

Browse files
committed
💡Renamed dev:forward script to dev
closes https://linear.app/ghost/issue/BER-3231/promote-devforward-to-dev The existing dev script has been renamed to dev:legacy and should be removed in the future. Similarly, there is an alias left in place for the dev:forward command that we can remove in the near future as well. The old dev command does not correctly start the new admin shell and should not be used other than as a temporary escape hatch.
1 parent 3ba9c54 commit 8d50a05

File tree

11 files changed

+44
-26
lines changed

11 files changed

+44
-26
lines changed

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Two categories of apps:
4444
```bash
4545
yarn # Install dependencies
4646
yarn setup # First-time setup (installs deps + submodules)
47-
yarn dev # Local dev (no Docker)
48-
yarn dev:debug # yarn dev with DEBUG=@tryghost*,ghost:* enabled
49-
yarn dev:forward # Run Ghost backend with deps in Docker + frontend dev servers
47+
yarn dev # Start development (Docker backend + host frontend dev servers)
48+
yarn dev:legacy # Local dev with legacy admin and without Docker (deprecated)
49+
yarn dev:legacy:debug # yarn dev:legacy with DEBUG=@tryghost*,ghost:* enabled
5050
```
5151

5252
### Building
@@ -100,9 +100,9 @@ yarn docker:test:unit # Run unit tests in Docker
100100
yarn docker:reset # Reset all Docker volumes (including database) and restart
101101
```
102102

103-
### Local development in Docker
103+
### How yarn dev works
104104

105-
The `yarn dev:forward` command uses a **hybrid Docker + host development** setup:
105+
The `yarn dev` command uses a **hybrid Docker + host development** setup:
106106

107107
**What runs in Docker:**
108108
- Ghost Core backend (with hot-reload via mounted source)
@@ -116,7 +116,7 @@ The `yarn dev:forward` command uses a **hybrid Docker + host development** setup
116116
**Setup:**
117117
```bash
118118
# Start everything (Docker + frontend dev servers)
119-
yarn dev:forward
119+
yarn dev
120120

121121
# With optional services (uses Docker Compose file composition)
122122
yarn dev:analytics # Include Tinybird analytics

apps/admin-x-settings/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Ghost Admin Settings micro-frontend.
1010

1111
### Running the development version
1212

13-
Run `yarn dev` to start the development server to test/develop the settings standalone. This will generate a demo site from the `index.html` file which renders the app and makes it available on http://localhost:5173
13+
Run `yarn dev` (in this package folder) to start the development server to test/develop the settings standalone. This will generate a demo site from the `index.html` file which renders the app and makes it available on http://localhost:5173
1414

1515
### Running inside Admin
1616

17-
Run `yarn dev` (like you would run Ghost dev normally) from the top-level repo. AdminX will automatically rebuild when you make changes.
17+
Run `yarn dev` from the top-level repo. This starts all frontend apps via Docker backend + host dev servers, and AdminX will automatically rebuild when you make changes.
1818

1919
## Develop
2020

apps/admin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Uses an **Ember Bridge** system for smooth migration:
1212
## Development
1313

1414
```bash
15-
# Start development server
15+
# Start development server (from monorepo root)
1616
yarn dev
1717
```
1818

apps/announcement-bar/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99

1010
### Running via Ghost `yarn dev` in root folder
1111

12-
You can automatically start the announcement-bar dev server when developing Ghost by running Ghost (in root folder) via `yarn dev --announcementbar`.
12+
Announcement Bar runs automatically when using Ghost's development command from the monorepo root:
13+
```bash
14+
yarn dev
15+
```
16+
17+
This starts all frontend apps (including Announcement Bar.)
1318

1419
## Release
1520

apps/comments-ui/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ Comments widget that is embedded at the bottom of posts in Ghost.
1010

1111
### Running via Ghost `yarn dev` in root folder
1212

13-
You can automatically start the comments dev server when developing Ghost by running Ghost (in root folder) via `yarn dev --all` or `yarn dev --comments`. This will host the comments JavaScript files, and makes sure that Ghost uses these locally hosted assets instead of the ones from the CDN.
13+
Comments UI runs automatically when using Ghost's development command from the monorepo root:
14+
```bash
15+
yarn dev
16+
```
1417

1518
## Release
1619

apps/portal/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@ Refer the [docs](https://ghost.org/help/setup-members/#customize-portal-settings
2828

2929
## Develop
3030

31-
Run Portal within the Ghost monorepo with:
31+
Portal runs automatically when using Ghost's development command from the monorepo root:
3232
```
33-
yarn dev --portal
33+
yarn dev
3434
```
3535

36-
Alternatively, use `yarn dev --all` to load Portal and other supported apps/services, see [dev.js](https://github.com/TryGhost/Ghost/blob/main/.github/scripts/dev.js) for more information.
37-
36+
This starts all frontend apps (including Portal.)
3837
---
3938

4039
To run Portal in a standalone fashion, use `yarn start` and open [http://localhost:3000](http://localhost:3000).

apps/signup-form/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,12 @@ Embed a Ghost signup form on any site.
1111

1212
### Running via Ghost `yarn dev` in root folder
1313

14-
You can automatically start the signup-form dev server when developing Ghost by running Ghost (in root folder) via `yarn dev --all`. This will only build the production build, without the demo site.
14+
Signup Form runs automatically when using Ghost's development command from the monorepo root:
15+
```bash
16+
yarn dev
17+
```
1518

16-
Running via `yarn dev --all --signup` or `yarn dev --signup` will also serve the demo site on `http://localhost:6173`.
19+
This starts all frontend apps (including Signup Form.)
1720

1821
### Running the development version only
1922

apps/sodo-search/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99

1010
### Running via Ghost `yarn dev` in root folder
1111

12-
You can automatically start the Sodo-Search dev server when developing Ghost by running Ghost (in root folder) via `yarn dev --all` or `yarn dev --search`.
12+
Sodo Search runs automatically when using Ghost's development command from the monorepo root:
13+
```bash
14+
yarn dev
15+
```
16+
17+
This starts all frontend apps (including Sodo Search.)
1318

1419
## Release
1520

docker/ghost-dev/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ This lightweight image:
2828
This image is used automatically when running:
2929

3030
```bash
31-
yarn dev # Starts Docker + frontend dev servers
32-
yarn dev:ghost # Starts only Docker services
31+
yarn dev # Starts Docker backend + frontend dev servers on host
32+
yarn dev:analytics # Include Tinybird analytics
33+
yarn dev:storage # Include MinIO S3-compatible object storage
34+
yarn dev:all # Include all optional services
3335
```

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ yarn setup
3838
#### 3. Start Ghost
3939

4040
```bash
41-
# Start development server
41+
# Start development server (uses Docker for backend services)
4242
yarn dev
4343
```
4444

0 commit comments

Comments
 (0)