docs: rebrand to The BED Stack (#81)

* refactor: rebrand to the bed stack * docs: add new logo and cleanup frontmatter * docs: transparent logo * docs: remove logo link * docs: make the docs detail more appealing * chore: rename media to clarify * docs: rename all to the-bed-stack * chore(devcontainers): add conventional commits extension BREAKING CHANGE: the entire repository has been rebranded which might require local changes.
agnyz · Oct 22, 2023 · 97b7602 · 97b7602
1 parent e030872
commit 97b7602
Show file tree

Hide file tree

Showing 20 changed files with 175 additions and 119 deletions.
diff --git a/.devcontainer.json b/.devcontainer.json
@@ -38,7 +38,8 @@
         "Pandy.bun",
         "github.vscode-github-actions",
         "yzhang.markdown-all-in-one",
-        "Vue.volar"
+        "Vue.volar",
+        "vivaxy.vscode-conventional-commits"
       ],
       "settings": {
         "editor.tabSize": 2,

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,5 +1,5 @@
 name: 🐞 Bug report
-description: Report an issue with `elysia-realworld-example-app`
+description: Report an issue with `the-bed-stack`
 labels: [pending triage]
 body:
   - type: markdown
@@ -10,7 +10,7 @@ body:
 
         - Read the `README.md`
         - Ask on [Discord](https://discord.gg/PH4rBdTU)
-        - Ask on [GitHub Discussions](https://github.com/agnyz/elysia-realworld-example-app/discussions)
+        - Ask on [GitHub Discussions](https://github.com/agnyz/the-bed-stack/discussions)
 
   - type: input
     id: version
@@ -47,11 +47,11 @@ body:
       label: Validations
       description: Before submitting the issue, please make sure you do the following
       options:
-        - label: Read the [Contributing Guidelines](https://github.com/agnyz/elysia-realworld-example-app/blob/main/CONTRIBUTING.md).
+        - label: Read the [Contributing Guidelines](https://github.com/agnyz/the-bed-stack/blob/main/CONTRIBUTING.md).
           required: true
-        - label: Check that there isn't [already an issue](https://github.com/agnyz/elysia-realworld-example-app/issues) that reports the same bug.
+        - label: Check that there isn't [already an issue](https://github.com/agnyz/the-bed-stack/issues) that reports the same bug.
           required: true
-        - label: Check that this is a concrete bug. For Q&A, open a [GitHub Discussion](https://github.com/agnyz/elysia-realworld-example-app/discussions).
+        - label: Check that this is a concrete bug. For Q&A, open a [GitHub Discussion](https://github.com/agnyz/the-bed-stack/discussions).
           required: true
         - label: The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
           required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -4,8 +4,8 @@ contact_links:
     url: https://discord.gg/PH4rBdTU
     about: Use Discord for instantly connecting with other developers on this project.
   - name: Discussions
-    url: https://github.com/agnyz/elysia-realworld-example-app/discussions
+    url: https://github.com/agnyz/the-bed-stack/discussions
     about: Use GitHub discussions for a message board-style forum for the project, discussing ideas, questions, etc.
   - name: Q&A
-    url: https://github.com/agnyz/elysia-realworld-example-app/discussions/categories/q-a?discussions_q=
+    url: https://github.com/agnyz/the-bed-stack/discussions/categories/q-a?discussions_q=
     about: See the full list of questions and answers, or ask your own.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,5 +1,5 @@
 name: 🚀 New feature proposal
-description: Propose a new feature to be added to `elysia-realworld-example-app`
+description: Propose a new feature to be added to `the-bed-stack`
 labels: ['enhancement: pending triage']
 body:
   - type: markdown
@@ -10,7 +10,7 @@ body:
     id: feature-description
     attributes:
       label: Clear and concise description of the problem
-      description: 'As a developer using `elysia-realworld-example-app` I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
+      description: 'As a developer using `the-bed-stack` I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
     validations:
       required: true
   - type: textarea
@@ -36,7 +36,7 @@ body:
       label: Validations
       description: Before submitting the FR, please make sure you do the following
       options:
-        - label: Read the [Contributing Guide](https://github.com/agnyz/elysia-realworld-example-app/blob/main/CONTRIBUTING.md).
+        - label: Read the [Contributing Guide](https://github.com/agnyz/the-bed-stack/blob/main/CONTRIBUTING.md).
           required: true
         - label: Read the `README.md`.
           required: true

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -9,7 +9,7 @@
 ### PR Checklist (Please do not remove)
 
 - [ ] Read the [CONTRIBUTING](
-  https://github.com/agnyz/elysia-realworld-example-app/blob/main/CONTRIBUTING.md) guide
+  https://github.com/agnyz/the-bed-stack/blob/main/CONTRIBUTING.md) guide
 - [ ] Title this PR according to the `type(scope): description` or `type: description` format
 - [ ] Provide description sufficient to understand the changes introduced in this PR, and, if necessary, some screenshots
 - [ ] Reference an issue or discussion where the feature or changes have been previously discussed

diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -16,6 +16,6 @@ jobs:
       - uses: google-github-actions/release-please-action@v3
         with:
           release-type: node
-          package-name: elysia-realworld-example-app
+          package-name: the-bed-stack
           # stay on 0.x until we have a stable release
           bump-minor-pre-major: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,60 +1,60 @@
 # Changelog
 
-## [0.1.0](https://github.com/agnyz/elysia-realworld-example-app/compare/v0.0.1...v0.1.0) (2023-10-18)
+## [0.1.0](https://github.com/agnyz/the-bed-stack/compare/v0.0.1...v0.1.0) (2023-10-18)
 
 
 ### Features
 
-* data faker ([#69](https://github.com/agnyz/elysia-realworld-example-app/issues/69)) ([528bf3d](https://github.com/agnyz/elysia-realworld-example-app/commit/528bf3d3f803f30abf9dfb18b8de9a0a610cc073))
-* PR template ([581ba87](https://github.com/agnyz/elysia-realworld-example-app/commit/581ba8751434c6afd4c1f95102f5ef4e3d70e2c1)), closes [#39](https://github.com/agnyz/elysia-realworld-example-app/issues/39)
+* data faker ([#69](https://github.com/agnyz/the-bed-stack/issues/69)) ([528bf3d](https://github.com/agnyz/the-bed-stack/commit/528bf3d3f803f30abf9dfb18b8de9a0a610cc073))
+* PR template ([581ba87](https://github.com/agnyz/the-bed-stack/commit/581ba8751434c6afd4c1f95102f5ef4e3d70e2c1)), closes [#39](https://github.com/agnyz/the-bed-stack/issues/39)
 
 ## 0.0.1 (2023-10-16)
 
 
 ### Features
 
-* add favicon ([4996119](https://github.com/agnyz/elysia-realworld-example-app/commit/49961196d1d034eb16ab3ae75371eb4587281636))
-* create-db.sh ([24e94f6](https://github.com/agnyz/elysia-realworld-example-app/commit/24e94f6a4221f6acf96208dc1cce401425e738fe))
-* date to timestamp ([e0a1dcb](https://github.com/agnyz/elysia-realworld-example-app/commit/e0a1dcb1fc70b5f75323f002be8aced2c7c702a8))
-* explicitly forward ports ([49a7ec3](https://github.com/agnyz/elysia-realworld-example-app/commit/49a7ec366f69fa036b864256114ac82ab9fd45b9))
-* generalize table drop ([b8b6689](https://github.com/agnyz/elysia-realworld-example-app/commit/b8b668939cc684f70a70a11c1ed78ce6283da7fa))
-* lint ([#44](https://github.com/agnyz/elysia-realworld-example-app/issues/44)) ([bc35136](https://github.com/agnyz/elysia-realworld-example-app/commit/bc351361d1899d18fb5cafce4bf2a5258de876d1))
-* migrate ([62230a2](https://github.com/agnyz/elysia-realworld-example-app/commit/62230a264fb5b9aaf6d6318ea2c2da857ded07e6))
-* open preview on mount ([7a53aa5](https://github.com/agnyz/elysia-realworld-example-app/commit/7a53aa5b2f06c94a070eea257fefdb90001c3924))
-* persist database ([8cf526c](https://github.com/agnyz/elysia-realworld-example-app/commit/8cf526c43dd8b92ac791aacc3b81f3e8160129a6))
-* postgres integration ([#35](https://github.com/agnyz/elysia-realworld-example-app/issues/35)) ([9014069](https://github.com/agnyz/elysia-realworld-example-app/commit/90140694a709265205cc2303001c5c15a70ca6e2))
-* postgresql devcontainer feature ([c3fedf5](https://github.com/agnyz/elysia-realworld-example-app/commit/c3fedf56c270c7c4c9184aa5d6a963f7506f5886))
-* release-please ([a8cbb70](https://github.com/agnyz/elysia-realworld-example-app/commit/a8cbb703a8b0505809d2536ab0d32eb285e67a36))
-* seed ([dc3c31b](https://github.com/agnyz/elysia-realworld-example-app/commit/dc3c31bd2bfb3d3068ae3c2a9d326b271cd31de9))
-* support bun-like .env hierarchy in docker compose ([#40](https://github.com/agnyz/elysia-realworld-example-app/issues/40)) ([2bf8fb0](https://github.com/agnyz/elysia-realworld-example-app/commit/2bf8fb037e5dbbb58699eaa82e4c167a7f01183c))
-* swagger endpoint ([#43](https://github.com/agnyz/elysia-realworld-example-app/issues/43)) ([e0c5f05](https://github.com/agnyz/elysia-realworld-example-app/commit/e0c5f05001e8ca167e64becbdab7a653ac3f5544))
-* swagger features ([4f75751](https://github.com/agnyz/elysia-realworld-example-app/commit/4f7575128d3652cf1efe65f0cb376c2ac56420b4))
-* use NestJS design patterns ([#37](https://github.com/agnyz/elysia-realworld-example-app/issues/37)) ([f4e73fb](https://github.com/agnyz/elysia-realworld-example-app/commit/f4e73fb36247db80142fdcb27a5d7e50af83e3e4))
-* user auth and related endpoints ([#47](https://github.com/agnyz/elysia-realworld-example-app/issues/47)) ([915f8cd](https://github.com/agnyz/elysia-realworld-example-app/commit/915f8cd8f5ed11383c8271e177257fa2f7fc6791))
-* wait-for-db retry until db is ready ([1702c8b](https://github.com/agnyz/elysia-realworld-example-app/commit/1702c8b9ab84f2ed598a943f6cd9ccc256d19e51))
-* wait-for-it ([90fccce](https://github.com/agnyz/elysia-realworld-example-app/commit/90fccce94b26ada6e152e7fe717686822a850fbe))
+* add favicon ([4996119](https://github.com/agnyz/the-bed-stack/commit/49961196d1d034eb16ab3ae75371eb4587281636))
+* create-db.sh ([24e94f6](https://github.com/agnyz/the-bed-stack/commit/24e94f6a4221f6acf96208dc1cce401425e738fe))
+* date to timestamp ([e0a1dcb](https://github.com/agnyz/the-bed-stack/commit/e0a1dcb1fc70b5f75323f002be8aced2c7c702a8))
+* explicitly forward ports ([49a7ec3](https://github.com/agnyz/the-bed-stack/commit/49a7ec366f69fa036b864256114ac82ab9fd45b9))
+* generalize table drop ([b8b6689](https://github.com/agnyz/the-bed-stack/commit/b8b668939cc684f70a70a11c1ed78ce6283da7fa))
+* lint ([#44](https://github.com/agnyz/the-bed-stack/issues/44)) ([bc35136](https://github.com/agnyz/the-bed-stack/commit/bc351361d1899d18fb5cafce4bf2a5258de876d1))
+* migrate ([62230a2](https://github.com/agnyz/the-bed-stack/commit/62230a264fb5b9aaf6d6318ea2c2da857ded07e6))
+* open preview on mount ([7a53aa5](https://github.com/agnyz/the-bed-stack/commit/7a53aa5b2f06c94a070eea257fefdb90001c3924))
+* persist database ([8cf526c](https://github.com/agnyz/the-bed-stack/commit/8cf526c43dd8b92ac791aacc3b81f3e8160129a6))
+* postgres integration ([#35](https://github.com/agnyz/the-bed-stack/issues/35)) ([9014069](https://github.com/agnyz/the-bed-stack/commit/90140694a709265205cc2303001c5c15a70ca6e2))
+* postgresql devcontainer feature ([c3fedf5](https://github.com/agnyz/the-bed-stack/commit/c3fedf56c270c7c4c9184aa5d6a963f7506f5886))
+* release-please ([a8cbb70](https://github.com/agnyz/the-bed-stack/commit/a8cbb703a8b0505809d2536ab0d32eb285e67a36))
+* seed ([dc3c31b](https://github.com/agnyz/the-bed-stack/commit/dc3c31bd2bfb3d3068ae3c2a9d326b271cd31de9))
+* support bun-like .env hierarchy in docker compose ([#40](https://github.com/agnyz/the-bed-stack/issues/40)) ([2bf8fb0](https://github.com/agnyz/the-bed-stack/commit/2bf8fb037e5dbbb58699eaa82e4c167a7f01183c))
+* swagger endpoint ([#43](https://github.com/agnyz/the-bed-stack/issues/43)) ([e0c5f05](https://github.com/agnyz/the-bed-stack/commit/e0c5f05001e8ca167e64becbdab7a653ac3f5544))
+* swagger features ([4f75751](https://github.com/agnyz/the-bed-stack/commit/4f7575128d3652cf1efe65f0cb376c2ac56420b4))
+* use NestJS design patterns ([#37](https://github.com/agnyz/the-bed-stack/issues/37)) ([f4e73fb](https://github.com/agnyz/the-bed-stack/commit/f4e73fb36247db80142fdcb27a5d7e50af83e3e4))
+* user auth and related endpoints ([#47](https://github.com/agnyz/the-bed-stack/issues/47)) ([915f8cd](https://github.com/agnyz/the-bed-stack/commit/915f8cd8f5ed11383c8271e177257fa2f7fc6791))
+* wait-for-db retry until db is ready ([1702c8b](https://github.com/agnyz/the-bed-stack/commit/1702c8b9ab84f2ed598a943f6cd9ccc256d19e51))
+* wait-for-it ([90fccce](https://github.com/agnyz/the-bed-stack/commit/90fccce94b26ada6e152e7fe717686822a850fbe))
 
 
 ### Bug Fixes
 
-* access db externally ([418f27a](https://github.com/agnyz/elysia-realworld-example-app/commit/418f27a354d35abd2aa35723bb6a20b6744e1cca))
-* biome fail commit when no files are processed ([fb6c519](https://github.com/agnyz/elysia-realworld-example-app/commit/fb6c519e1b99dd3789570f956c4ed8dd1f2c5897))
-* breaking error after update ([3b453db](https://github.com/agnyz/elysia-realworld-example-app/commit/3b453dbf26dc1a72108de00d1731e195754f7be5))
-* change demo URL link ([51ed7c0](https://github.com/agnyz/elysia-realworld-example-app/commit/51ed7c0456397c452a3a4ff67d7e343c8da419eb))
-* create-db correctly call wait-for-db script ([c29ea00](https://github.com/agnyz/elysia-realworld-example-app/commit/c29ea00a540410a2e3cc2278b8c36a9fcdce47b5))
-* create-db.sh reference correct script ([5d8cca7](https://github.com/agnyz/elysia-realworld-example-app/commit/5d8cca74a70d3bcd51bf23f2458a2342400b495b))
-* create-db.sh reference correct script ([6099902](https://github.com/agnyz/elysia-realworld-example-app/commit/6099902fd7f89c3f1abdab87cafe7e439094e4f5))
-* drizzle studio not showing entities ([b4becf5](https://github.com/agnyz/elysia-realworld-example-app/commit/b4becf5618d088a6ff359f352c2d5af8bbde7e1c))
-* formatter ([e375e49](https://github.com/agnyz/elysia-realworld-example-app/commit/e375e49c56a58a4ce2d9c62483b1289d7fc5e1f4))
-* migrations directory ([25c5d89](https://github.com/agnyz/elysia-realworld-example-app/commit/25c5d89131960b030b7eeeb75dcd28557949024c))
-* postCreateCommand wait-for-it directory ([0518690](https://github.com/agnyz/elysia-realworld-example-app/commit/0518690ecc659bd8ff6410c6016eaf0103c0f248))
-* postCreateCommand wait-for-it script ([145492c](https://github.com/agnyz/elysia-realworld-example-app/commit/145492c4416204c6bb5cf94f60969575ff190278))
-* remove bio and image fields from insert ([d4b9d8a](https://github.com/agnyz/elysia-realworld-example-app/commit/d4b9d8ab99e7afb1f3e786febc4895ffa55dbdd5))
-* stay on 0.x ([6f92913](https://github.com/agnyz/elysia-realworld-example-app/commit/6f92913450f801a882ae4393c3c6f938db1f3c52))
-* temporarily rely on rebuilding ([0d70816](https://github.com/agnyz/elysia-realworld-example-app/commit/0d7081642f486041ed6e55885640bdf95fe56ffb))
-* vitepress deployment ([b765fc5](https://github.com/agnyz/elysia-realworld-example-app/commit/b765fc56105c48a3b927064d14d8c9647c9e32f3)), closes [#48](https://github.com/agnyz/elysia-realworld-example-app/issues/48)
+* access db externally ([418f27a](https://github.com/agnyz/the-bed-stack/commit/418f27a354d35abd2aa35723bb6a20b6744e1cca))
+* biome fail commit when no files are processed ([fb6c519](https://github.com/agnyz/the-bed-stack/commit/fb6c519e1b99dd3789570f956c4ed8dd1f2c5897))
+* breaking error after update ([3b453db](https://github.com/agnyz/the-bed-stack/commit/3b453dbf26dc1a72108de00d1731e195754f7be5))
+* change demo URL link ([51ed7c0](https://github.com/agnyz/the-bed-stack/commit/51ed7c0456397c452a3a4ff67d7e343c8da419eb))
+* create-db correctly call wait-for-db script ([c29ea00](https://github.com/agnyz/the-bed-stack/commit/c29ea00a540410a2e3cc2278b8c36a9fcdce47b5))
+* create-db.sh reference correct script ([5d8cca7](https://github.com/agnyz/the-bed-stack/commit/5d8cca74a70d3bcd51bf23f2458a2342400b495b))
+* create-db.sh reference correct script ([6099902](https://github.com/agnyz/the-bed-stack/commit/6099902fd7f89c3f1abdab87cafe7e439094e4f5))
+* drizzle studio not showing entities ([b4becf5](https://github.com/agnyz/the-bed-stack/commit/b4becf5618d088a6ff359f352c2d5af8bbde7e1c))
+* formatter ([e375e49](https://github.com/agnyz/the-bed-stack/commit/e375e49c56a58a4ce2d9c62483b1289d7fc5e1f4))
+* migrations directory ([25c5d89](https://github.com/agnyz/the-bed-stack/commit/25c5d89131960b030b7eeeb75dcd28557949024c))
+* postCreateCommand wait-for-it directory ([0518690](https://github.com/agnyz/the-bed-stack/commit/0518690ecc659bd8ff6410c6016eaf0103c0f248))
+* postCreateCommand wait-for-it script ([145492c](https://github.com/agnyz/the-bed-stack/commit/145492c4416204c6bb5cf94f60969575ff190278))
+* remove bio and image fields from insert ([d4b9d8a](https://github.com/agnyz/the-bed-stack/commit/d4b9d8ab99e7afb1f3e786febc4895ffa55dbdd5))
+* stay on 0.x ([6f92913](https://github.com/agnyz/the-bed-stack/commit/6f92913450f801a882ae4393c3c6f938db1f3c52))
+* temporarily rely on rebuilding ([0d70816](https://github.com/agnyz/the-bed-stack/commit/0d7081642f486041ed6e55885640bdf95fe56ffb))
+* vitepress deployment ([b765fc5](https://github.com/agnyz/the-bed-stack/commit/b765fc56105c48a3b927064d14d8c9647c9e32f3)), closes [#48](https://github.com/agnyz/the-bed-stack/issues/48)
 
 
 ### Miscellaneous Chores
 
-* release 0.0.1 ([a68c06a](https://github.com/agnyz/elysia-realworld-example-app/commit/a68c06a3679855ff635cd37c48f57a7d433b6618))
+* release 0.0.1 ([a68c06a](https://github.com/agnyz/the-bed-stack/commit/a68c06a3679855ff635cd37c48f57a7d433b6618))
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -27,7 +27,7 @@ We are a group of open-source developers who develop, use, promote the Elysia Re
 
 * **Transparency**
 
-    While the decision-making process is not always public, the results of the decision making process must be public. Decisions will be made after thoughtful consideration of the community's input through [Discord](https://discord.gg/PH4rBdTU) and [GitHub Discussions](https://github.com/agnyz/elysia-realworld-example-app/discussions).
+    While the decision-making process is not always public, the results of the decision making process must be public. Decisions will be made after thoughtful consideration of the community's input through [Discord](https://discord.gg/PH4rBdTU) and [GitHub Discussions](https://github.com/agnyz/the-bed-stack/discussions).
 
 * **Automation**