https://github.com/cdleveille/fresh-bun
Single-page web app project template curated for performance, developer experience, and type safety. Bun, Elysia, React, TanStack Router/Query.
https://github.com/cdleveille/fresh-bun
bun eden elysia fresh fullstack react tanstack-query tanstack-router template typescript vite websocket
Last synced: 4 months ago
JSON representation
Single-page web app project template curated for performance, developer experience, and type safety. Bun, Elysia, React, TanStack Router/Query.
- Host: GitHub
- URL: https://github.com/cdleveille/fresh-bun
- Owner: cdleveille
- License: mit
- Created: 2023-09-19T23:25:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-02T04:15:01.000Z (4 months ago)
- Last Synced: 2025-07-02T04:33:35.330Z (4 months ago)
- Topics: bun, eden, elysia, fresh, fullstack, react, tanstack-query, tanstack-router, template, typescript, vite, websocket
- Language: TypeScript
- Homepage: https://fresh-bun.fly.dev
- Size: 3.01 MB
- Stars: 12
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - cdleveille/fresh-bun - Single-page web app project template curated for performance, developer experience, and type safety. Bun, Elysia, React, TanStack Router/Query. (TypeScript)
README
# 
fresh-bun
Single-page web app project template curated for performance, developer experience, and type safety.
## 🔧 Stack
- [Bun](https://bun.sh) - server runtime, package manager, script runner
- [Elysia](https://elysiajs.com) - server framework
- [Eden](https://elysiajs.com/eden/overview) - end-to-end type safety
- [React](https://react.dev) - user interface
- [TanStack Router](https://tanstack.com/router) - client-side routing
- [TanStack Query](https://tanstack.com/query), [Zustand](https://zustand-demo.pmnd.rs) - state management
- [TypeScript](https://www.typescriptlang.org), [Biome](https://biomejs.dev), [Lefthook](https://lefthook.dev) - code quality/style
- [Vite](https://vite.dev) - dev server, bundler
## ✨ Features
- **100% Type-Safe API**: Full static type-safety between the server and client. See [api.ts](https://github.com/cdleveille/fresh-bun/blob/main/src/server/api.ts) and [useApi.ts](https://github.com/cdleveille/fresh-bun/blob/main/src/client/hooks/useApi.ts) for simple HTTP and WebSocket examples.
- **Automatic API Documentation**: Interactive [Scalar](https://github.com/scalar/scalar) documentation is automatically generated and served at `/api/reference`. The raw OpenAPI JSON is available at `/api/reference/json`.
- **Progressive Web App Capable**: Meets PWA requirements for an installable, native app-like experience. Scores a near-perfect [PageSpeed Insights](https://pagespeed.web.dev/analysis?url=https%3A%2F%2Ffresh-bun.fly.dev&form_factor=desktop) report out of the box.
- **Offline Support**: A [service worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) caches static assets and API responses, enabling offline functionality and faster subsequent loads with fewer requests to the server.
- **Production Ready**: Includes a multi-stage `Dockerfile` that compiles the app into a standalone binary and runs it in a minimal distroless image. Pre-configured GitHub workflows for continuous integration and deploying to [fly.io](https://fly.io) on pushes to the `main` branch.
## 🚧 Scope
The following are not currently implemented, but may be added in the future:
- Server-Side Rendering (SSR) / React Server Components (RSC)
- Database / ORM
- Authentication / Authorization
- CSS Framework / UI Component Library
- Unit / E2E Tests
- Logging / Analytics
## 🚀 Getting Started
### Setup
1. Install [Git](https://git-scm.com/downloads), [Bun](https://bun.sh/docs/installation), and optionally [Docker](https://docs.docker.com/get-docker) (useful for testing production builds locally)
2. Clone this repository and install dependencies:
```bash
git clone https://github.com/cdleveille/fresh-bun.git
cd fresh-bun
bun install
```
### Local Development
Run the Elysia backend and Vite dev server concurrently:
```bash
bun dev
```
### Production Build
**Option 1:** Bundle client and start server:
```bash
bun bundle
bun start
```
**Option 2:** Build app and run standalone binary:
```bash
bun run build
./main
```
**Option 3:** Build Docker image and run in container:
```bash
docker build -t fresh-bun .
docker run -p 3000:3000 fresh-bun
```