You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Developer's Guide
2
2
3
-
Hey there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great and we truly appreciate your time and effort.
3
+
Hey there! Contributing to this project is highly encouraged. Community help is essential for maintaining its quality, and every effort is appreciated.
4
4
5
5
> [!IMPORTANT]
6
6
> Before submitting your contribution, please take a moment and read through the following guidelines.
@@ -27,7 +27,7 @@ Build the project for production. The result is under `dist/`.
27
27
28
28
### `bun check`
29
29
30
-
We use [Biome](https://biomejs.dev/) for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
30
+
Biome is used for **both linting and formatting**. It is an ultra-fast, Rust based linter and formatter.
31
31
It also lints JSON.
32
32
33
33
You can also run `bun fix` to apply any safe fixes automatically.
@@ -54,7 +54,7 @@ For typo fixes, it's recommended to batch multiple typo fixes into one pull requ
54
54
55
55
### Pull Request
56
56
57
-
If you don't know how to send a Pull Request, we recommend reading[the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
57
+
If you don't know how to send a Pull Request, it is recommended to read[the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
58
58
59
59
If your PR fixes or resolves an existing issue, please add the following line in your PR description according to the following example:
60
60
@@ -75,19 +75,19 @@ Replacing:
75
75
76
76
This will let GitHub know the issues are linked, and automatically close them once the PR gets merged. Learn more at [the guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
77
77
78
-
It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use `Squash and Merge`to squash the commits into one commit when merging.
78
+
It's ok to have multiple commits in a single PR; changes do not need to be rebased or force pushed, as Squash and Merge will be used to combine the commits into one when merging.
79
79
80
80
## 📖 References
81
81
82
82
### Lint
83
83
84
-
We use [Biome](https://biomejs.dev/) for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
84
+
Biome is used for both linting and formatting with [a few custom rules](./biome.jsonc). It is an ultra-fast, Rust based linter and formatter.
85
85
86
86
<table><tr><td>
87
87
88
88
#### IDE Setup
89
89
90
-
We recommend using [VS Code](https://code.visualstudio.com/) along with:
90
+
[Visual Studio Code](https://code.visualstudio.com/) is recommended for the best experience along with:
91
91
-[Biome extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) for linting and formatting.
92
92
-[ArkType extension](https://marketplace.visualstudio.com/items?itemName=arktypeio.arkdark) for syntax highlighting and type-safe regex support.
Copy file name to clipboardExpand all lines: README.md
+1-4Lines changed: 1 addition & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,7 @@
12
12
</div>
13
13
14
14
> [!TIP]
15
-
> ⚡ **New!** Our Prisma-based alternative to Bedstack was just approved on CodebaseShow. Check it out: [Bepstack](https://github.com/bedtime-coders/bepstack)
16
-
17
-
> [!TIP]
18
-
> ⚡ **New!** We've added support for [Drizzle v1 Beta](https://orm.drizzle.team/roadmap) in _Bedstack (Stripped)_. Check it out: [`drizzle-v1` branch](https://github.com/bedtime-coders/bedstack-stripped/tree/drizzle-v1)
15
+
> ⚡ We support [Drizzle v1 Beta](https://orm.drizzle.team/roadmap)! Check it out: [`drizzle-v1` branch](https://github.com/bedtime-coders/bedstack-stripped/tree/drizzle-v1)
Copy file name to clipboardExpand all lines: SUPPORT.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ This article explains where to get help with Bedstack.
4
4
Please read through the following guidelines.
5
5
6
6
> [!WARNING]
7
-
> Before participating in our community, please read our
7
+
> Before participating in the community, please read the
8
8
> [code of conduct](CODE_OF_CONDUCT.md).
9
9
> By interacting with this repository, organization, or community you agree to
10
10
> abide by its terms.
11
11
12
12
## Asking quality questions
13
13
14
-
Questions can go to our[Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
14
+
Questions can go to the[Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub discussions](https://github.com/bedtime-coders/bedstack/discussions).
15
15
16
-
Help us help you!
16
+
Clear questions are easier to answer.
17
17
Spend time framing questions and add links and resources.
18
18
Spending the extra time up front can help save everyone time in the long run.
19
19
Here are some tips:
@@ -29,7 +29,7 @@ Here are some tips:
29
29
* Provide sample code, such as a [CodeSandbox](https://codesandbox.io/) or video, if possible
30
30
* Screenshots can help, but if there’s important text such as code or error
31
31
messages in them, please also provide those as text
32
-
* The more time you put into asking your question, the better we can help you
32
+
* The more time put into asking a question, the better the community can provide assistance
Copy file name to clipboardExpand all lines: apps/www/getting-started.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Getting Started
2
2
3
-
Getting started with this RealWorld project is as easy as installing a few prerequisites, running a few commands, and opening your favorite text editor. We'd love to have you [contribute](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md)to this project. If you have any questions, please reach out on [Discord](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](
3
+
Getting started with this RealWorld project is as easy as installing a few prerequisites, running a few commands, and opening your favorite text editor. [Contributions](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md)are welcome. If you have any questions, please reach out on [Discord](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](
@@ -11,7 +11,7 @@ Getting started with this RealWorld project is as easy as installing a few prere
11
11
-[Bun](https://bun.com/) version 1.0.6 or higher.
12
12
- Terminal for accessing Bun via its command-line interface (CLI).
13
13
- Text Editor with TypeScript support.
14
-
-We recommend [Visual Studio Code](https://code.visualstudio.com/); other IDEs have been reported to cause issues with ElysiaJS's type inference system.
14
+
-[Visual Studio Code](https://code.visualstudio.com/) is recommended for the best experience; other IDEs have been reported to cause issues with ElysiaJS's type inference system.
15
15
16
16
### Setup
17
17
@@ -43,7 +43,7 @@ $ bun dev
43
43
44
44
## What's Next?
45
45
46
-
*Once you're ready to contribute, check out our [contributing guide](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md). We're excited to have you!
47
-
*If you're looking for a place to start, check out our[good first issues](https://github.com/bedtime-coders/bedstack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
48
-
*If you need support, check out our[support page](https://github.com/bedtime-coders/bedstack/blob/main/SUPPORT.md).
49
-
*If you have any questions or just want to chat, join our[Discord server](https://discord.gg/8UcP9QB5AV) or [GitHub Discussions](https://github.com/bedtime-coders/bedstack/discussions).
46
+
*To contribute, see the [contributing guide](https://github.com/bedtime-coders/bedstack/blob/main/CONTRIBUTING.md).
47
+
*For a place to start, see the[good first issues](https://github.com/bedtime-coders/bedstack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Copy file name to clipboardExpand all lines: apps/www/what-is-bedstack.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This [repository](https://github.com/bedtime-coders/bedstack) implements the Rea
8
8
9
9
## Core technologies
10
10
11
-
We carefully chose some of the latest and greatest technologies from the bleeding edge that share our core philosophy. They are:
11
+
The selected technologies share Bedstack's core philosophy. They are:
12
12
13
13
-**[Bun](https://bun.com/)** - All-in-one JavaScript runtime & toolkit designed for speed, complete with a bundler, test runner, and Node.js-compatible package manager.
14
14
@@ -33,14 +33,14 @@ For **experienced developers**, RealWorld is a practical benchmark. It is a stru
33
33
34
34
## Why Bun, ElysiaJS, Drizzle, or any of the core technologies?
35
35
36
-
When [Bun](https://bun.com/) was announced, it promised a simpler and more unified approach to modern TypeScript development. Instead of evaluating it in isolation, we chose to test it under real conditions.
36
+
When [Bun](https://bun.com/) was announced, it promised a simpler and more unified approach to modern TypeScript development. It was tested under real conditions.
37
37
38
38
The question was simple:
39
39
40
40
> What better way to evaluate a new runtime than to build a full RealWorld backend with it?
41
41
42
42
ElysiaJS, Drizzle, and ArkType were selected because they are designed with Bun and TypeScript-first development in mind, and because they reinforce the same core values.
43
43
44
-
Bedstack is unapologetically opinionated. A tech stack is not a menu of options, it is a curated path to correct decisions. ArkType was chosen because it offers excellent type inference and makes the correct choice the easiest choice.
44
+
Bedstack is unapologetically opinionated. A tech stack is not a menu of options, it is a curated path to correct decisions. ArkType offers excellent type inference and makes the correct choice the easiest choice.
45
45
46
46
That said, Bedstack relies on the [Standard Schema](https://github.com/standard-schema/standard-schema) interface. Advanced users can substitute another compliant validator if needed, but ArkType remains the recommended and supported path.
0 commit comments