Skip to content

Commit c862076

Browse files
Rename 'bun up' to 'bun db' (#141)
### Description <!-- Provide a comprehensive description here about what your PR aims to solve. --> <!-- You may also add additional context --> Update the "bun up" command to "bun db" since it's used to spin up a db container. It's a better name. If we use "bun docs" to spin up a docs server, we should use "bun db" to spin up a db server. --- ### PR Checklist <!-- Please do not remove this section --> <!-- Mark each item with an "x" ([ ] becomes [x]) --> - [x] Read the Developer's Guide in [CONTRIBUTING.md](https://github.com/agnyz/bedstack/blob/main/CONTRIBUTING.md) - [x] Use a concise title to represent the changes introduced in this PR - [x] Provide a detailed description of the changes introduced in this PR, and, if necessary, some screenshots - [x] Reference an issue or discussion where the feature or changes have been previously discussed - [x] Add a failing test that passes with the changes introduced in this PR, or explain why it's not feasible - [x] Add documentation for the feature or changes introduced in this PR to the docs; you can run them with `bun docs` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated setup instructions to now use the `bun db` command for initiating the database service, replacing the previous `bun up` command in both the quickstart and getting-started guides. - **Chores** - Adjusted the underlying command reference in the configuration to align with the new `bun db` command. - **Bug Fixes** - Removed the `app` service configuration from the Docker Compose setup. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 0df91cc commit c862076

File tree

4 files changed

+3
-25
lines changed

4 files changed

+3
-25
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
3. **Ensure Docker daemon is running and spin up the Postgres+Bun container**
3535

3636
```sh
37-
bun up
37+
bun db
3838
```
3939
3. **Migrate the schema to the database**
4040

docker-compose.yml

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,5 @@ services:
2121
ports:
2222
- ${POSTGRES_PORT}:5432
2323

24-
app:
25-
image: node:20-bullseye
26-
restart: unless-stopped
27-
28-
volumes:
29-
- ..:/workspaces:cached
30-
- ../scripts:/scripts:cached
31-
32-
# Overrides default command so things don't shut down after the process ends.
33-
command: sleep infinity
34-
35-
# Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
36-
network_mode: service:db
37-
# Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
38-
# (Adding the "ports" property to this file will not forward from a Codespace.)
39-
40-
# depends_on:
41-
# - db
42-
# environment:
43-
# - POSTGRES_HOST=db # connect to the Postgres container with Docker Networking
44-
# - POSTGRES_PORT=5432 # use internal port of Postgres container
45-
4624
volumes:
4725
postgres-data:

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Getting started with this RealWorld project is as easy as installing a few prere
2626
2. **Ensure Docker daemon is running and spin up the Postgres+Bun container**
2727

2828
```sh
29-
$ bun up
29+
$ bun db
3030
```
3131
3. **Migrate the schema to the database**
3232

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"docs": "vitepress dev docs",
1818
"docs:build": "vitepress build docs",
1919
"docs:preview": "vitepress preview docs",
20-
"up": "./scripts/create-start-container-with-env.sh",
20+
"db": "./scripts/create-start-container-with-env.sh",
2121
"db:generate": "drizzle-kit generate --config=db/config.ts",
2222
"db:migrate": "drizzle-kit migrate --config=db/config.ts",
2323
"db:push": "drizzle-kit push --config=db/config.ts",

0 commit comments

Comments
 (0)