|
1 | | -<div align='center'> |
| 1 | +#  |
2 | 2 |
|
3 | | -<img src="logo.png" alt="Logo for Bedstack RealWorld example" width=200> |
4 | | -<h1>Conduit - Bedstack RealWorld Example</h1> |
| 3 | +> ### Elysia + Drizzle codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld) spec and API. |
| 4 | +
|
| 5 | +### [Docs](https://bedstack.js.org/) [RealWorld](https://github.com/gothinkster/realworld) |
5 | 6 |
|
6 | 7 | [](https://github.com/bedstack/elysia-drizzle-realworld-example/actions/workflows/tests.yml?query=branch%3Amain+event%3Apush) [](https://github.com/bedstack/elysia-drizzle-realworld-example/blob/main/LICENSE) [](https://bun.com/) [](https://elysiajs.com/) [](https://drizzle.team/) [](https://biomejs.dev/) [](https://scalar.com/) [](https://github.com/bedstack/elysia-drizzle-realworld-example/stargazers/) |
7 | 8 |
|
8 | | -[RealWorld](https://realworld-docs.netlify.app/) example app for [Bedstack](https://bedstack.js.org/) |
9 | | -</div> |
| 9 | +This codebase was created to demonstrate a fully fledged backend application built with **[Elysia](https://elysiajs.com/)** and **[Drizzle ORM](https://orm.drizzle.team/)** including CRUD operations, authentication, routing, pagination, and more. |
| 10 | + |
| 11 | +We've gone to great lengths to adhere to the **Elysia** and **Drizzle** community styleguides & best practices. |
| 12 | + |
| 13 | +For more information on how this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo. |
10 | 14 |
|
11 | | -<br/> |
12 | | -<br/> |
13 | | -<br/> |
| 15 | +# How it works |
14 | 16 |
|
15 | | -### [Read the docs](https://bedstack.js.org/) |
| 17 | +This is a [Bedstack](https://bedstack.js.org/) implementation - an architecture pattern for building modern TypeScript backends. The stack includes: |
16 | 18 |
|
17 | | -<br/> |
18 | | -<br/> |
| 19 | +- **[Bun](https://bun.sh/)** - Fast JavaScript runtime and package manager |
| 20 | +- **[Elysia](https://elysiajs.com/)** - Ergonomic web framework for Bun |
| 21 | +- **[Drizzle ORM](https://orm.drizzle.team/)** - TypeScript ORM with SQL-like syntax |
| 22 | +- **[PostgreSQL](https://www.postgresql.org/)** - Database |
| 23 | +- **[ArkType](https://arktype.io/)** - Runtime validation |
| 24 | +- **[Biome](https://biomejs.dev/)** - Linting and formatting |
19 | 25 |
|
20 | | -## Quickstart |
| 26 | +# Getting started |
21 | 27 |
|
22 | 28 | 1. **Install dependencies** |
23 | 29 |
|
|
62 | 68 | bun db:studio |
63 | 69 | ``` |
64 | 70 |
|
65 | | - |
66 | | -## Deploy to production |
| 71 | +# Deploy to production |
67 | 72 |
|
68 | 73 | > [!TIP] |
69 | 74 | > See more info in ElysiaJS's [Deploy to production](https://elysiajs.com/patterns/deploy) pattern. |
|
80 | 85 | bun preview |
81 | 86 | ``` |
82 | 87 |
|
83 | | -## Need help? |
| 88 | +# Need help? |
84 | 89 |
|
85 | 90 | If you have questions or ideas: |
86 | 91 | - Open a [GitHub Discussion](https://github.com/bedstack/elysia-drizzle-realworld-example/discussions) |
87 | 92 | - Open an [Issue](https://github.com/bedstack/elysia-drizzle-realworld-example/issues) if you believe you found a bug |
88 | 93 |
|
89 | | -## Supporting Bedstack |
90 | | -
|
91 | | -If you love Bedstack, you can support the project by **starring it on GitHub**! |
| 94 | +# Contributors |
92 | 95 |
|
93 | | -You are also welcome to [contribute to the project](https://github.com/bedstack/elysia-drizzle-realworld-example/blob/main/CONTRIBUTING.md) and join the wonderful people who have contributed: |
| 96 | +You are welcome to [contribute to the project](https://github.com/bedstack/elysia-drizzle-realworld-example/blob/main/CONTRIBUTING.md)! |
94 | 97 |
|
95 | 98 | <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> |
96 | 99 | <!-- prettier-ignore-start --> |
|
0 commit comments