Getting Started ​

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 to this project. If you have any questions, please reach out on Discord or GitHub Discussions!

Installation ​

Prerequisites ​

• Bun version 1.0.6 or higher.
• Terminal for accessing Bun via its command-line interface (CLI).
• Text Editor with TypeScript support.
  • We recommend Visual Studio Code; other IDEs have been reported to cause issues with ElysiaJS's type inference system.

Setup ​

1. Clone and install dependencies

$ gh repo clone agnyz/the-bed-stack
$ cd the-bed-stack
$ bun i

$ gh repo clone agnyz/the-bed-stack
$ cd the-bed-stack
$ bun i

2. Ensure Docker daemon is running and spin up the Postgres+Bun container

$ bun up

$ bun up

3. Migrate the schema to the database

$ bun db:migrate

$ bun db:migrate

4. Run the app

$ bun dev

$ bun dev

What's Next? ​

• Once you're ready to contribute, check out our contributing guide. We're excited to have you!
• If you're looking for a place to start, check out our good first issues.
• If you need support, check out our support page.
• If have any questions or just want to chat, join our Discord server or GitHub Discussions.