chore: Updated README and version bump 477b1481
Steve · 2025-08-09 14:48 2 file(s) · +72 −46
README.md +33 −7
8 8
9 9
While there are plenty of existing app building stacks out there, many of them are either bloated, outdated, or have too much of a vendor lock-in. bhvr is built with the opinion that you should be able to deploy your client or server in any environment while also keeping type safety.
10 10
11 +
## Quickstart
12 +
13 +
Make sure [bun](https://bun.sh) is installed
14 +
15 +
```bash
16 +
bun --version
17 +
```
18 +
19 +
Run the command below to make a new bhvr project
20 +
21 +
```bash
22 +
bun create bhvr@latest my-app
23 +
```
24 +
25 +
Once complete run the dev server
26 +
27 +
```bash
28 +
cd my-app
29 +
bun dev
30 +
```
31 +
32 +
> [!NOTE]
33 +
> Visit [bhvr.dev](https://bhvr.dev) for the full documentation!
34 +
11 35
## Features
12 36
13 37
- **Full-Stack TypeScript**: End-to-end type safety between client and server
236 260
Deplying each piece is very versatile and can be done numerous ways, and exploration into automating these will happen at a later date. Here are some references in the meantime.
237 261
238 262
**Client**
239 -
- [Orbiter](https://orbiter.host)
240 -
- [GitHub Pages](https://vite.dev/guide/static-deploy.html#github-pages)
241 -
- [Netlify](https://vite.dev/guide/static-deploy.html#netlify)
242 -
- [Cloudflare Pages](https://vite.dev/guide/static-deploy.html#cloudflare-pages)
263 +
- [Orbiter](https://bhvr.dev/deployment/client/orbiter)
264 +
- [GitHub Pages](https://bhvr.dev/deployment/client/github-pages)
265 +
- [Netlify](https://bhvr.dev/deployment/client/netlify)
266 +
- [Cloudflare Pages](https://bhvr.dev/deployment/client/cloudflare-pages)
243 267
244 268
**Server**
245 -
- [Cloudflare Worker](https://gist.github.com/stevedylandev/4aa1fc569bcba46b7169193c0498d0b3)
246 -
- [Bun](https://hono.dev/docs/getting-started/bun)
247 -
- [Node.js](https://hono.dev/docs/getting-started/nodejs)
269 +
- [Orbiter](https://bhvr.dev/deployment/server/orbiter)
270 +
- [Cloudflare Worker](https://bhvr.dev/deployment/server/cloudflare-workers)
271 +
- [Bun](https://bhvr.dev/deployment/server/railway)
272 +
- [Node.js](https://bhvr.dev/deployment/server/railway)
248 273
249 274
## Type Sharing
250 275
256 281
257 282
## Learn More
258 283
284 +
- [bhvr Documentation](https://bhvr.dev)
259 285
- [Bun Documentation](https://bun.sh/docs)
260 286
- [Vite Documentation](https://vitejs.dev/guide/)
261 287
- [React Documentation](https://react.dev/learn)
package.json +39 −39
1 1
{
2 -
  "name": "bhvr",
3 -
  "version": "0.4.0",
4 -
  "description": "A monorepo template built with Bun, Hono, Vite, and React",
5 -
  "author": "Steve Simkins",
6 -
  "license": "MIT",
7 -
  "homepage": "https://github.com/stevedylandev/bhvr",
8 -
  "packageManager": "bun@1.2.4",
9 -
  "workspaces": [
10 -
    "./server",
11 -
    "./client",
12 -
    "./shared"
13 -
  ],
14 -
  "scripts": {
15 -
    "dev": "turbo dev",
16 -
    "dev:client": "turbo dev --filter=client",
17 -
    "dev:server": "turbo dev --filter=server",
18 -
    "build": "turbo build",
19 -
    "build:client": "turbo build --filter=client",
20 -
    "build:server": "turbo build --filter=server",
21 -
    "lint": "turbo lint",
22 -
    "type-check": "turbo type-check",
23 -
    "test": "turbo test",
24 -
    "postinstall": "turbo build --filter=shared --filter=server"
25 -
  },
26 -
  "keywords": [
27 -
    "bun",
28 -
    "hono",
29 -
    "react",
30 -
    "vite",
31 -
    "monorepo",
32 -
    "turbo"
33 -
  ],
34 -
  "devDependencies": {
35 -
    "bun-types": "latest",
36 -
    "turbo": "^2.5.5"
37 -
  },
38 -
  "peerDependencies": {
39 -
    "typescript": "^5.7.3"
40 -
  }
2 +
	"name": "bhvr",
3 +
	"version": "0.5.0",
4 +
	"description": "A monorepo template built with Bun, Hono, Vite, and React",
5 +
	"author": "Steve Simkins",
6 +
	"license": "MIT",
7 +
	"homepage": "https://github.com/stevedylandev/bhvr",
8 +
	"packageManager": "bun@1.2.4",
9 +
	"workspaces": [
10 +
		"./server",
11 +
		"./client",
12 +
		"./shared"
13 +
	],
14 +
	"scripts": {
15 +
		"dev": "turbo dev",
16 +
		"dev:client": "turbo dev --filter=client",
17 +
		"dev:server": "turbo dev --filter=server",
18 +
		"build": "turbo build",
19 +
		"build:client": "turbo build --filter=client",
20 +
		"build:server": "turbo build --filter=server",
21 +
		"lint": "turbo lint",
22 +
		"type-check": "turbo type-check",
23 +
		"test": "turbo test",
24 +
		"postinstall": "turbo build --filter=shared --filter=server"
25 +
	},
26 +
	"keywords": [
27 +
		"bun",
28 +
		"hono",
29 +
		"react",
30 +
		"vite",
31 +
		"monorepo",
32 +
		"turbo"
33 +
	],
34 +
	"devDependencies": {
35 +
		"bun-types": "latest",
36 +
		"turbo": "^2.5.5"
37 +
	},
38 +
	"peerDependencies": {
39 +
		"typescript": "^5.7.3"
40 +
	}
41 41
}