Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
<img src="https://img.shields.io/github/actions/workflow/status/techfusionid/elysia-production-template/ci.yml?label=CI&logo=github&style=flat" alt="CI">
</a>
<img src="https://img.shields.io/badge/OpenAPI-documented-6BA539?logo=openapi&style=flat" alt="OpenAPI">
<a href="https://github.com/techfusionid/elysia-production-template/generate">
<img src="https://img.shields.io/badge/use%20this-template-2ea44f?style=flat-square" />
</a>
</p>

## Features
Expand All @@ -55,7 +58,7 @@

## Why use this starter?

**Elysia.js is fast.** It's currently the fastest framework in the Bun ecosystem, with [benchmarks showing performance](https://elysiajs.com/at-glance.html#performance) that can match Golang and Rust frameworks.
**Elysia.js is fast.** It's currently one of the fastest frameworks in the Bun ecosystem, with [benchmarks showing performance](https://elysiajs.com/at-glance.html#performance) that can match Golang and Rust frameworks (based on TechEmpower Benchmarks).

**The problem?** Setting up Authentication, ORM, Docker, and logging from scratch for a production-ready app takes hours.

Expand All @@ -68,9 +71,21 @@ This boilerplate provides a **simple, ready-to-use, production-grade foundation*
- Keep full control over configuration while avoiding boilerplate fatigue
- Use modern, type-safe tooling without framework lock-in

---

## Quick Start

**Clone the repo:**
### 1. Use This Template (Recommended)

Click the green **"Use this template"** button at the top of this repo — or use the direct link:

👉 [**Create from template**](https://github.com/techfusionid/elysia-production-template/generate)

> Creates a clean repo without git history.

### 2. Clone the repository (Alternative)

If you prefer cloning manually:

```bash
git clone https://github.com/techfusionid/elysia-production-template.git
Expand Down Expand Up @@ -164,6 +179,8 @@ Log verbosity can be controlled using the `LOG_LEVEL` environment variable.
bun run dev # Start dev server with hot reload
```

---

**🐳 Local Development with Docker PostgreSQL**

For local development, it's recommended to run PostgreSQL via Docker
Expand Down Expand Up @@ -388,7 +405,7 @@ This project aims to stay **simple, production-focused, and easy to extend**, so

---

## How to contribute
### How to contribute

1. Fork this repository
2. Create a new branch from `main`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"elysia": "^1.4.0",
"elysia-rate-limit": "^4.4.2",
"lru-cache": "^11.2.4",
"pino": "^9.5.0",
"pino": "^10.2.1",
"pino-pretty": "^13.0.0",
"postgres": "^3.4.5",
"resend": "^6.7.0"
Expand Down