Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kapsonfire-DE/bun-bakery
Bun-Bakery is a web framework for Bun. It uses a file based router in style like svelte-kit. No need to define routes during runtime.
https://github.com/Kapsonfire-DE/bun-bakery
Last synced: 3 months ago
JSON representation
Bun-Bakery is a web framework for Bun. It uses a file based router in style like svelte-kit. No need to define routes during runtime.
- Host: GitHub
- URL: https://github.com/Kapsonfire-DE/bun-bakery
- Owner: Kapsonfire-DE
- License: mit
- Created: 2022-07-11T16:38:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-02T20:15:24.000Z (over 1 year ago)
- Last Synced: 2024-07-15T18:19:07.132Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 56
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bun - Bun Bakery - A web framework for Bun that uses a file based router like Next.js/svelte-kit (Frameworks & Libraries)
README
[](https://www.npmjs.com/package/@kapsonfire/bun-bakery)
[](https://www.npmjs.com/package/@kapsonfire/bun-bakery)
[](https://www.npmjs.com/package/@kapsonfire/bun-bakery)
[](https://www.npmjs.com/package/@kapsonfire/bun-bakery)
[](https://sonarcloud.io/summary/new_code?id=Kapsonfire-DE_bun-bakery)
[](https://sonarcloud.io/summary/new_code?id=Kapsonfire-DE_bun-bakery)
# Bun Bakery
**Bun-Bakery** is a web framework for [Bun](https://github.com/oven-sh/bun). It uses a file based router in style like svelte-kit. No need to define routes during runtime.
## Quick Start
```bash
bun add @kapsonfire/bun-bakery
```
On your main script import Router from bun-bakery and define your pathes. i.e. `main.ts`
```typescript
import {Router} from "@kapsonfire/bun-bakery"
new Router({
assetsPath: import.meta.dir + '/assets/',
routesPath: import.meta.dir + '/routes/'
})
```
After that run the server and open your browser `http://localhost:3000`
```bash
bun main.ts
```
## Routing
Routes are added automatically when creating files inside your `routesPath` when exporting functions with the corresponding Method Names.
Given example above create `index.ts` inside `routes/` and export a `GET` function calling `ctx.sendResponse()`.
```typescript
import {Context} from "@kapsonfire/bun-bakery"
export async function GET(ctx: Context) {
ctx.sendResponse(new Response('hello world!'));
}
```
### Parameters
Routes can have parameters inside dirname and/or filename. Just put the parameter name inside brackets and it will be added to `ctx.params`.
In example: given `routes/user/[username].ts` and open `http://localhost:3000/user/kapsonfire`
```typescript
import {Context} from "@kapsonfire/bun-bakery"
export async function GET(ctx: Context) {
ctx.sendResponse(new Response('hello '+ ctx.params.username +'!'));
}
```
will output `hello kapsonfire!`
### Spread Parameters
Routes can also have wildcard/spread parameters.
In example: given `routes/users/[...usernames].ts` and open `http://localhost:3000/users/kapsonfire/jarred/tricked`
```typescript
import {Context} from "@kapsonfire/bun-bakery"
export async function GET(ctx: Context) {
ctx.json(JSON.stringify(ctx.params));
}
```
will output
```json
{"usernames":["kapsonfire","jarred","tricked"]}
```
### Websocket Server
Bun-Bakery supports websocket endpoint export for Bun.serve({...}).
Just export `WEBSOCKET` as Object registering the websocket hooks.
In example: given `routes/websocket/user.ts`
```typescript
export const WEBSOCKET = {
message: (ws, message) => {
console.log('RCV:', message);
ws.send('ECHO: ' + message);
},
upgrade: (ctx: Context) => {
ctx.acceptWebsocketUpgrade();
}
}
```
More detailed example:
```typescript
export const WEBSOCKET = {
message: (ws, message) => {
console.log('RCV:', message);
ws.send('ECHO: ' + message);
},
upgrade: (ctx: Context) => {
ctx.acceptWebsocketUpgrade({
data: {
name: new URL(req.url).searchParams.get("name") || "Friend",
},
headers: {
'Set-Cookie': 'name=value'
}
});
}
}
```
This will accept Websocket Connections on `ws://localhost:3000/websocket/user
**NOTE**: Websocket Endpoints don't support params in the url.
### Handlers
Inside the context variable you can access the native bun `Request` object inside `ctx.request`.
`ctx.sendResponse` expects a native bun `Response` object.
## Middlewares
bun-bakery supports some life-cycles to add middleware
* **onRequest** `will be called before the router handles the request`
* **onRoute** `will be called before the route function will be called`
* **onResponse** `will be called after the route function finished`
```typescript
router.addMiddleware({
onRequest: (ctx: Context) => { ctx.params.injected = "1"; console.log('onRequest', ctx) },
onRoute: (ctx: Context) => console.log('onRoute', ctx),
onResponse: (ctx: Context) => {
ctx.response.headers.set('content-type', 'application/jsonx');
console.log('onResponse', ctx)
},
});
```