Skip to content

Commit 366d962

Browse files
committed
refactor: update project name in package.json to match new branding
1 parent f58516e commit 366d962

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
1-
<div align='center'>
1+
# ![RealWorld Example App](logo.png)
22

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/)&nbsp;&nbsp;&nbsp;&nbsp;[RealWorld](https://github.com/gothinkster/realworld)
56

67
[![Tests Status](https://github.com/bedstack/elysia-drizzle-realworld-example/actions/workflows/tests.yml/badge.svg?event=push&branch=main&)](https://github.com/bedstack/elysia-drizzle-realworld-example/actions/workflows/tests.yml?query=branch%3Amain+event%3Apush) [![License](https://custom-icon-badges.demolab.com/github/license/bedstack/elysia-drizzle-realworld-example?label=License&color=blue&logo=law&labelColor=0d1117)](https://github.com/bedstack/elysia-drizzle-realworld-example/blob/main/LICENSE) [![Bun](https://img.shields.io/badge/Bun-14151a?logo=bun&logoColor=fbf0df)](https://bun.com/) [![ElysiaJS](https://custom-icon-badges.demolab.com/badge/ElysiaJS-0f172b.svg?logo=elysia)](https://elysiajs.com/) [![Drizzle](https://img.shields.io/badge/Drizzle-C5F74F?logo=drizzle&logoColor=000)](https://drizzle.team/) [![Biome](https://img.shields.io/badge/Biome-24272f?logo=biome&logoColor=f6f6f9)](https://biomejs.dev/) [![Scalar](https://img.shields.io/badge/Scalar-080808?logo=scalar&logoColor=e7e7e7)](https://scalar.com/) [![Star](https://custom-icon-badges.demolab.com/github/stars/bedstack/elysia-drizzle-realworld-example?logo=star&logoColor=373737&label=Star)](https://github.com/bedstack/elysia-drizzle-realworld-example/stargazers/)
78

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.
1014

11-
<br/>
12-
<br/>
13-
<br/>
15+
# How it works
1416

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:
1618

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
1925

20-
## Quickstart
26+
# Getting started
2127

2228
1. **Install dependencies**
2329

@@ -62,8 +68,7 @@
6268
bun db:studio
6369
```
6470

65-
66-
## Deploy to production
71+
# Deploy to production
6772

6873
> [!TIP]
6974
> See more info in ElysiaJS's [Deploy to production](https://elysiajs.com/patterns/deploy) pattern.
@@ -80,17 +85,15 @@
8085
bun preview
8186
```
8287
83-
## Need help?
88+
# Need help?
8489
8590
If you have questions or ideas:
8691
- Open a [GitHub Discussion](https://github.com/bedstack/elysia-drizzle-realworld-example/discussions)
8792
- Open an [Issue](https://github.com/bedstack/elysia-drizzle-realworld-example/issues) if you believe you found a bug
8893
89-
## Supporting Bedstack
90-
91-
If you love Bedstack, you can support the project by **starring it on GitHub**!
94+
# Contributors
9295
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)!
9497
9598
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
9699
<!-- prettier-ignore-start -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@bedstack/elysia-drizzle-realworld-example",
2+
"name": "conduit-backend",
33
"description": "Backend for Conduit - Medium.com clone, built with Elysia + Drizzle",
44
"version": "0.0.0",
55
"module": "src/main.ts",

0 commit comments

Comments
 (0)