bun-api-starter 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +118 -0
- package/dist/chunk-L5ZPLS3Y.js +33 -0
- package/dist/chunk-L5ZPLS3Y.js.map +1 -0
- package/dist/cli.cjs +55 -0
- package/dist/cli.cjs.map +1 -0
- package/dist/cli.d.cts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +25 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.cjs +37 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +4 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/package.json +64 -0
- package/template/.env.example +1 -0
- package/template/README.md +24 -0
- package/template/biome.json +26 -0
- package/template/package.json +22 -0
- package/template/src/index.ts +16 -0
- package/template/src/routes/health.ts +3 -0
- package/template/src/server.ts +13 -0
- package/template/tsconfig.json +16 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Razi
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# bun-api-starter
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
create-bun-api my-api
|
|
7
|
+
|
|
|
8
|
+
v
|
|
9
|
+
.env ──> PORT ──> Elysia ──> / ( service info )
|
|
10
|
+
| └──> /health ( health check )
|
|
11
|
+
|
|
|
12
|
+
bun --watch src/server.ts
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
**One-command scaffold for a type-safe Bun + Elysia REST API.**
|
|
16
|
+
|
|
17
|
+
</div>
|
|
18
|
+
|
|
19
|
+
<div align="center">
|
|
20
|
+
|
|
21
|
+
[](https://www.npmjs.com/package/bun-api-starter)
|
|
22
|
+
[](https://www.npmjs.com/package/bun-api-starter)
|
|
23
|
+
[](LICENSE)
|
|
24
|
+
[](https://github.com/knownasrazi/bun-api-starter/actions)
|
|
25
|
+
[](https://bun.sh)
|
|
26
|
+
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## start an api
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
bunx create-bun-api my-api
|
|
35
|
+
cd my-api
|
|
36
|
+
|
|
37
|
+
bun install
|
|
38
|
+
bun run dev
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Banner appears on `http://localhost:5000`. Port comes from `.env`.
|
|
42
|
+
|
|
43
|
+
## what lands in the folder
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
my-api
|
|
47
|
+
|-- package.json # elysia 1, dotenvx, bun scripts
|
|
48
|
+
|-- tsconfig.json # strict, bundler resolution
|
|
49
|
+
|-- biome.json # formatting + linting
|
|
50
|
+
|-- .env.example # PORT=5000
|
|
51
|
+
|-- src
|
|
52
|
+
| |-- server.ts # app, routes, listen
|
|
53
|
+
| `-- routes
|
|
54
|
+
| `-- health.ts # example route module
|
|
55
|
+
`-- README.md # scaffolded with your name
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## routes it ships with
|
|
59
|
+
|
|
60
|
+
| method | path | response |
|
|
61
|
+
| ------ | ---- | -------- |
|
|
62
|
+
| GET | `/` | `{ "name": "<project>", "status": "online" }` |
|
|
63
|
+
| GET | `/health` | `{ "ok": true }` |
|
|
64
|
+
|
|
65
|
+
## add a route
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
// src/routes/echo.ts
|
|
69
|
+
import { Elysia } from "elysia";
|
|
70
|
+
|
|
71
|
+
export const echo = new Elysia().post("/echo", ({ body }) => body, {
|
|
72
|
+
body: { message: String },
|
|
73
|
+
});
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
// src/server.ts
|
|
78
|
+
import { echo } from "./routes/echo";
|
|
79
|
+
// ...
|
|
80
|
+
const app = new Elysia().get("/", () => ({ status: "online" })).use(echo);
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Every route module is just an `Elysia` instance - compose them with `.use()`.
|
|
84
|
+
|
|
85
|
+
## why this over wrestling setup
|
|
86
|
+
|
|
87
|
+
| pain | solution |
|
|
88
|
+
| ---- | -------- |
|
|
89
|
+
| Elysia + Bun handshake | pre-wired in `server.ts` |
|
|
90
|
+
| `.env` never loads | dotenvx imported up top |
|
|
91
|
+
| no lint/format baseline | pinned `biome.json` |
|
|
92
|
+
| route files with no pattern | `src/routes/*.ts` + `.use()` |
|
|
93
|
+
|
|
94
|
+
## details
|
|
95
|
+
|
|
96
|
+
- Elysia serves OpenAPI at `/swagger` when running with `BUN_RUNTIME_TRANSPILER=1` - see Elysia docs for the recipe.
|
|
97
|
+
- `bun run dev` hot-reloads on save.
|
|
98
|
+
|
|
99
|
+
## development of this package
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
git clone https://github.com/knownasrazi/bun-api-starter.git
|
|
103
|
+
cd bun-api-starter
|
|
104
|
+
bun install
|
|
105
|
+
bun run release
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## license
|
|
109
|
+
|
|
110
|
+
[MIT](./LICENSE) + [Razi](https://github.com/knownasrazi)
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
<div align="center">
|
|
115
|
+
|
|
116
|
+
*one command in. an api answering requests.*
|
|
117
|
+
|
|
118
|
+
</div>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { mkdir, readdir, readFile, writeFile } from 'fs/promises';
|
|
2
|
+
import { join, dirname, resolve, basename } from 'path';
|
|
3
|
+
import { fileURLToPath } from 'url';
|
|
4
|
+
|
|
5
|
+
// src/scaffold.ts
|
|
6
|
+
var PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), "..");
|
|
7
|
+
var TEMPLATE_DIR = join(PROJECT_ROOT, "template");
|
|
8
|
+
async function scaffold(targetDir) {
|
|
9
|
+
const target = resolve(targetDir);
|
|
10
|
+
const projectName = basename(target);
|
|
11
|
+
await mkdir(target, { recursive: true });
|
|
12
|
+
await copyTree(TEMPLATE_DIR, target, projectName);
|
|
13
|
+
return target;
|
|
14
|
+
}
|
|
15
|
+
async function copyTree(from, to, projectName) {
|
|
16
|
+
const entries = await readdir(from, { withFileTypes: true });
|
|
17
|
+
for (const entry of entries) {
|
|
18
|
+
const src = join(from, entry.name);
|
|
19
|
+
const dest = join(to, entry.name);
|
|
20
|
+
if (entry.isDirectory()) {
|
|
21
|
+
await mkdir(dest, { recursive: true });
|
|
22
|
+
await copyTree(src, dest, projectName);
|
|
23
|
+
} else {
|
|
24
|
+
let data = await readFile(src, "utf8");
|
|
25
|
+
data = data.replaceAll("<PACKAGE_NAME>", projectName);
|
|
26
|
+
await writeFile(dest, data, "utf8");
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export { TEMPLATE_DIR, scaffold };
|
|
32
|
+
//# sourceMappingURL=chunk-L5ZPLS3Y.js.map
|
|
33
|
+
//# sourceMappingURL=chunk-L5ZPLS3Y.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/scaffold.ts"],"names":[],"mappings":";;;;;AAIA,IAAM,YAAA,GAAe,KAAK,OAAA,CAAQ,aAAA,CAAc,YAAY,GAAG,CAAC,GAAG,IAAI,CAAA;AAEhE,IAAM,YAAA,GAAe,IAAA,CAAK,YAAA,EAAc,UAAU;AAEzD,eAAsB,SAAS,SAAA,EAAoC;AACjE,EAAA,MAAM,MAAA,GAAS,QAAQ,SAAS,CAAA;AAChC,EAAA,MAAM,WAAA,GAAc,SAAS,MAAM,CAAA;AACnC,EAAA,MAAM,KAAA,CAAM,MAAA,EAAQ,EAAE,SAAA,EAAW,MAAM,CAAA;AACvC,EAAA,MAAM,QAAA,CAAS,YAAA,EAAc,MAAA,EAAQ,WAAW,CAAA;AAChD,EAAA,OAAO,MAAA;AACT;AAEA,eAAe,QAAA,CAAS,IAAA,EAAc,EAAA,EAAY,WAAA,EAAoC;AACpF,EAAA,MAAM,UAAU,MAAM,OAAA,CAAQ,MAAM,EAAE,aAAA,EAAe,MAAM,CAAA;AAC3D,EAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,IAAA,MAAM,GAAA,GAAM,IAAA,CAAK,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AACjC,IAAA,MAAM,IAAA,GAAO,IAAA,CAAK,EAAA,EAAI,KAAA,CAAM,IAAI,CAAA;AAChC,IAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,MAAA,MAAM,KAAA,CAAM,IAAA,EAAM,EAAE,SAAA,EAAW,MAAM,CAAA;AACrC,MAAA,MAAM,QAAA,CAAS,GAAA,EAAK,IAAA,EAAM,WAAW,CAAA;AAAA,IACvC,CAAA,MAAO;AACL,MAAA,IAAI,IAAA,GAAO,MAAM,QAAA,CAAS,GAAA,EAAK,MAAM,CAAA;AACrC,MAAA,IAAA,GAAO,IAAA,CAAK,UAAA,CAAW,gBAAA,EAAkB,WAAW,CAAA;AACpD,MAAA,MAAM,SAAA,CAAU,IAAA,EAAM,IAAA,EAAM,MAAM,CAAA;AAAA,IACpC;AAAA,EACF;AACF","file":"chunk-L5ZPLS3Y.js","sourcesContent":["import { mkdir, readdir, readFile, writeFile } from \"node:fs/promises\";\nimport { basename, dirname, join, resolve } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), \"..\");\n\nexport const TEMPLATE_DIR = join(PROJECT_ROOT, \"template\");\n\nexport async function scaffold(targetDir: string): Promise<string> {\n const target = resolve(targetDir);\n const projectName = basename(target);\n await mkdir(target, { recursive: true });\n await copyTree(TEMPLATE_DIR, target, projectName);\n return target;\n}\n\nasync function copyTree(from: string, to: string, projectName: string): Promise<void> {\n const entries = await readdir(from, { withFileTypes: true });\n for (const entry of entries) {\n const src = join(from, entry.name);\n const dest = join(to, entry.name);\n if (entry.isDirectory()) {\n await mkdir(dest, { recursive: true });\n await copyTree(src, dest, projectName);\n } else {\n let data = await readFile(src, \"utf8\");\n data = data.replaceAll(\"<PACKAGE_NAME>\", projectName);\n await writeFile(dest, data, \"utf8\");\n }\n }\n}\n"]}
|
package/dist/cli.cjs
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
'use strict';
|
|
3
|
+
|
|
4
|
+
var promises = require('fs/promises');
|
|
5
|
+
var path = require('path');
|
|
6
|
+
var url = require('url');
|
|
7
|
+
|
|
8
|
+
var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
|
|
9
|
+
var PROJECT_ROOT = path.join(path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('cli.cjs', document.baseURI).href)))), "..");
|
|
10
|
+
var TEMPLATE_DIR = path.join(PROJECT_ROOT, "template");
|
|
11
|
+
async function scaffold(targetDir) {
|
|
12
|
+
const target = path.resolve(targetDir);
|
|
13
|
+
const projectName = path.basename(target);
|
|
14
|
+
await promises.mkdir(target, { recursive: true });
|
|
15
|
+
await copyTree(TEMPLATE_DIR, target, projectName);
|
|
16
|
+
return target;
|
|
17
|
+
}
|
|
18
|
+
async function copyTree(from, to, projectName) {
|
|
19
|
+
const entries = await promises.readdir(from, { withFileTypes: true });
|
|
20
|
+
for (const entry of entries) {
|
|
21
|
+
const src = path.join(from, entry.name);
|
|
22
|
+
const dest = path.join(to, entry.name);
|
|
23
|
+
if (entry.isDirectory()) {
|
|
24
|
+
await promises.mkdir(dest, { recursive: true });
|
|
25
|
+
await copyTree(src, dest, projectName);
|
|
26
|
+
} else {
|
|
27
|
+
let data = await promises.readFile(src, "utf8");
|
|
28
|
+
data = data.replaceAll("<PACKAGE_NAME>", projectName);
|
|
29
|
+
await promises.writeFile(dest, data, "utf8");
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// src/cli.ts
|
|
35
|
+
var name = process.argv[2] ?? "";
|
|
36
|
+
if (name === "") {
|
|
37
|
+
console.error("usage: create-bun-api <project-name>");
|
|
38
|
+
process.exit(1);
|
|
39
|
+
}
|
|
40
|
+
if (name.includes(" ")) {
|
|
41
|
+
console.error("error: project name must be a single word");
|
|
42
|
+
process.exit(1);
|
|
43
|
+
}
|
|
44
|
+
async function main() {
|
|
45
|
+
const target = await scaffold(name);
|
|
46
|
+
console.log(`scaffolded a bun api at ${target}`);
|
|
47
|
+
console.log("next:");
|
|
48
|
+
console.log(` cd ${name}`);
|
|
49
|
+
console.log(" bun install");
|
|
50
|
+
console.log(" cp .env.example .env # optional, PORT defaults to 5000");
|
|
51
|
+
console.log(" bun run dev");
|
|
52
|
+
}
|
|
53
|
+
void main();
|
|
54
|
+
//# sourceMappingURL=cli.cjs.map
|
|
55
|
+
//# sourceMappingURL=cli.cjs.map
|
package/dist/cli.cjs.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/scaffold.ts","../src/cli.ts"],"names":["join","dirname","fileURLToPath","resolve","basename","mkdir","readdir","readFile","writeFile"],"mappings":";;;;;;;;AAIA,IAAM,YAAA,GAAeA,UAAKC,YAAA,CAAQC,iBAAA,CAAc,yPAAe,CAAC,GAAG,IAAI,CAAA;AAEhE,IAAM,YAAA,GAAeF,SAAA,CAAK,YAAA,EAAc,UAAU,CAAA;AAEzD,eAAsB,SAAS,SAAA,EAAoC;AACjE,EAAA,MAAM,MAAA,GAASG,aAAQ,SAAS,CAAA;AAChC,EAAA,MAAM,WAAA,GAAcC,cAAS,MAAM,CAAA;AACnC,EAAA,MAAMC,cAAA,CAAM,MAAA,EAAQ,EAAE,SAAA,EAAW,MAAM,CAAA;AACvC,EAAA,MAAM,QAAA,CAAS,YAAA,EAAc,MAAA,EAAQ,WAAW,CAAA;AAChD,EAAA,OAAO,MAAA;AACT;AAEA,eAAe,QAAA,CAAS,IAAA,EAAc,EAAA,EAAY,WAAA,EAAoC;AACpF,EAAA,MAAM,UAAU,MAAMC,gBAAA,CAAQ,MAAM,EAAE,aAAA,EAAe,MAAM,CAAA;AAC3D,EAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,IAAA,MAAM,GAAA,GAAMN,SAAA,CAAK,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AACjC,IAAA,MAAM,IAAA,GAAOA,SAAA,CAAK,EAAA,EAAI,KAAA,CAAM,IAAI,CAAA;AAChC,IAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,MAAA,MAAMK,cAAA,CAAM,IAAA,EAAM,EAAE,SAAA,EAAW,MAAM,CAAA;AACrC,MAAA,MAAM,QAAA,CAAS,GAAA,EAAK,IAAA,EAAM,WAAW,CAAA;AAAA,IACvC,CAAA,MAAO;AACL,MAAA,IAAI,IAAA,GAAO,MAAME,iBAAA,CAAS,GAAA,EAAK,MAAM,CAAA;AACrC,MAAA,IAAA,GAAO,IAAA,CAAK,UAAA,CAAW,gBAAA,EAAkB,WAAW,CAAA;AACpD,MAAA,MAAMC,kBAAA,CAAU,IAAA,EAAM,IAAA,EAAM,MAAM,CAAA;AAAA,IACpC;AAAA,EACF;AACF;;;AC3BA,IAAM,IAAA,GAAO,OAAA,CAAQ,IAAA,CAAK,CAAC,CAAA,IAAK,EAAA;AAEhC,IAAI,SAAS,EAAA,EAAI;AACf,EAAA,OAAA,CAAQ,MAAM,sCAAsC,CAAA;AACpD,EAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAChB;AACA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,EAAG;AACtB,EAAA,OAAA,CAAQ,MAAM,2CAA2C,CAAA;AACzD,EAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAChB;AAEA,eAAe,IAAA,GAAsB;AACnC,EAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,IAAI,CAAA;AAClC,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,wBAAA,EAA2B,MAAM,CAAA,CAAE,CAAA;AAC/C,EAAA,OAAA,CAAQ,IAAI,OAAO,CAAA;AACnB,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAE,CAAA;AAC1B,EAAA,OAAA,CAAQ,IAAI,eAAe,CAAA;AAC3B,EAAA,OAAA,CAAQ,IAAI,2DAA2D,CAAA;AACvE,EAAA,OAAA,CAAQ,IAAI,eAAe,CAAA;AAC7B;AAEA,KAAK,IAAA,EAAK","file":"cli.cjs","sourcesContent":["import { mkdir, readdir, readFile, writeFile } from \"node:fs/promises\";\nimport { basename, dirname, join, resolve } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), \"..\");\n\nexport const TEMPLATE_DIR = join(PROJECT_ROOT, \"template\");\n\nexport async function scaffold(targetDir: string): Promise<string> {\n const target = resolve(targetDir);\n const projectName = basename(target);\n await mkdir(target, { recursive: true });\n await copyTree(TEMPLATE_DIR, target, projectName);\n return target;\n}\n\nasync function copyTree(from: string, to: string, projectName: string): Promise<void> {\n const entries = await readdir(from, { withFileTypes: true });\n for (const entry of entries) {\n const src = join(from, entry.name);\n const dest = join(to, entry.name);\n if (entry.isDirectory()) {\n await mkdir(dest, { recursive: true });\n await copyTree(src, dest, projectName);\n } else {\n let data = await readFile(src, \"utf8\");\n data = data.replaceAll(\"<PACKAGE_NAME>\", projectName);\n await writeFile(dest, data, \"utf8\");\n }\n }\n}\n","#!/usr/bin/env bun\nimport { scaffold } from \"./scaffold.js\";\n\nconst name = process.argv[2] ?? \"\";\n\nif (name === \"\") {\n console.error(\"usage: create-bun-api <project-name>\");\n process.exit(1);\n}\nif (name.includes(\" \")) {\n console.error(\"error: project name must be a single word\");\n process.exit(1);\n}\n\nasync function main(): Promise<void> {\n const target = await scaffold(name);\n console.log(`scaffolded a bun api at ${target}`);\n console.log(\"next:\");\n console.log(` cd ${name}`);\n console.log(\" bun install\");\n console.log(\" cp .env.example .env # optional, PORT defaults to 5000\");\n console.log(\" bun run dev\");\n}\n\nvoid main();\n"]}
|
package/dist/cli.d.cts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
package/dist/cli.js
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
#!/usr/bin/env bun
|
|
2
|
+
import { scaffold } from './chunk-L5ZPLS3Y.js';
|
|
3
|
+
|
|
4
|
+
// src/cli.ts
|
|
5
|
+
var name = process.argv[2] ?? "";
|
|
6
|
+
if (name === "") {
|
|
7
|
+
console.error("usage: create-bun-api <project-name>");
|
|
8
|
+
process.exit(1);
|
|
9
|
+
}
|
|
10
|
+
if (name.includes(" ")) {
|
|
11
|
+
console.error("error: project name must be a single word");
|
|
12
|
+
process.exit(1);
|
|
13
|
+
}
|
|
14
|
+
async function main() {
|
|
15
|
+
const target = await scaffold(name);
|
|
16
|
+
console.log(`scaffolded a bun api at ${target}`);
|
|
17
|
+
console.log("next:");
|
|
18
|
+
console.log(` cd ${name}`);
|
|
19
|
+
console.log(" bun install");
|
|
20
|
+
console.log(" cp .env.example .env # optional, PORT defaults to 5000");
|
|
21
|
+
console.log(" bun run dev");
|
|
22
|
+
}
|
|
23
|
+
void main();
|
|
24
|
+
//# sourceMappingURL=cli.js.map
|
|
25
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/cli.ts"],"names":[],"mappings":";;;;AAGA,IAAM,IAAA,GAAO,OAAA,CAAQ,IAAA,CAAK,CAAC,CAAA,IAAK,EAAA;AAEhC,IAAI,SAAS,EAAA,EAAI;AACf,EAAA,OAAA,CAAQ,MAAM,sCAAsC,CAAA;AACpD,EAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAChB;AACA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAG,CAAA,EAAG;AACtB,EAAA,OAAA,CAAQ,MAAM,2CAA2C,CAAA;AACzD,EAAA,OAAA,CAAQ,KAAK,CAAC,CAAA;AAChB;AAEA,eAAe,IAAA,GAAsB;AACnC,EAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,IAAI,CAAA;AAClC,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,wBAAA,EAA2B,MAAM,CAAA,CAAE,CAAA;AAC/C,EAAA,OAAA,CAAQ,IAAI,OAAO,CAAA;AACnB,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,KAAA,EAAQ,IAAI,CAAA,CAAE,CAAA;AAC1B,EAAA,OAAA,CAAQ,IAAI,eAAe,CAAA;AAC3B,EAAA,OAAA,CAAQ,IAAI,2DAA2D,CAAA;AACvE,EAAA,OAAA,CAAQ,IAAI,eAAe,CAAA;AAC7B;AAEA,KAAK,IAAA,EAAK","file":"cli.js","sourcesContent":["#!/usr/bin/env bun\nimport { scaffold } from \"./scaffold.js\";\n\nconst name = process.argv[2] ?? \"\";\n\nif (name === \"\") {\n console.error(\"usage: create-bun-api <project-name>\");\n process.exit(1);\n}\nif (name.includes(\" \")) {\n console.error(\"error: project name must be a single word\");\n process.exit(1);\n}\n\nasync function main(): Promise<void> {\n const target = await scaffold(name);\n console.log(`scaffolded a bun api at ${target}`);\n console.log(\"next:\");\n console.log(` cd ${name}`);\n console.log(\" bun install\");\n console.log(\" cp .env.example .env # optional, PORT defaults to 5000\");\n console.log(\" bun run dev\");\n}\n\nvoid main();\n"]}
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var promises = require('fs/promises');
|
|
4
|
+
var path = require('path');
|
|
5
|
+
var url = require('url');
|
|
6
|
+
|
|
7
|
+
var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
|
|
8
|
+
// src/scaffold.ts
|
|
9
|
+
var PROJECT_ROOT = path.join(path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)))), "..");
|
|
10
|
+
var TEMPLATE_DIR = path.join(PROJECT_ROOT, "template");
|
|
11
|
+
async function scaffold(targetDir) {
|
|
12
|
+
const target = path.resolve(targetDir);
|
|
13
|
+
const projectName = path.basename(target);
|
|
14
|
+
await promises.mkdir(target, { recursive: true });
|
|
15
|
+
await copyTree(TEMPLATE_DIR, target, projectName);
|
|
16
|
+
return target;
|
|
17
|
+
}
|
|
18
|
+
async function copyTree(from, to, projectName) {
|
|
19
|
+
const entries = await promises.readdir(from, { withFileTypes: true });
|
|
20
|
+
for (const entry of entries) {
|
|
21
|
+
const src = path.join(from, entry.name);
|
|
22
|
+
const dest = path.join(to, entry.name);
|
|
23
|
+
if (entry.isDirectory()) {
|
|
24
|
+
await promises.mkdir(dest, { recursive: true });
|
|
25
|
+
await copyTree(src, dest, projectName);
|
|
26
|
+
} else {
|
|
27
|
+
let data = await promises.readFile(src, "utf8");
|
|
28
|
+
data = data.replaceAll("<PACKAGE_NAME>", projectName);
|
|
29
|
+
await promises.writeFile(dest, data, "utf8");
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
exports.TEMPLATE_DIR = TEMPLATE_DIR;
|
|
35
|
+
exports.scaffold = scaffold;
|
|
36
|
+
//# sourceMappingURL=index.cjs.map
|
|
37
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/scaffold.ts"],"names":["join","dirname","fileURLToPath","resolve","basename","mkdir","readdir","readFile","writeFile"],"mappings":";;;;;;;;AAIA,IAAM,YAAA,GAAeA,UAAKC,YAAA,CAAQC,iBAAA,CAAc,2PAAe,CAAC,GAAG,IAAI,CAAA;AAEhE,IAAM,YAAA,GAAeF,SAAA,CAAK,YAAA,EAAc,UAAU;AAEzD,eAAsB,SAAS,SAAA,EAAoC;AACjE,EAAA,MAAM,MAAA,GAASG,aAAQ,SAAS,CAAA;AAChC,EAAA,MAAM,WAAA,GAAcC,cAAS,MAAM,CAAA;AACnC,EAAA,MAAMC,cAAA,CAAM,MAAA,EAAQ,EAAE,SAAA,EAAW,MAAM,CAAA;AACvC,EAAA,MAAM,QAAA,CAAS,YAAA,EAAc,MAAA,EAAQ,WAAW,CAAA;AAChD,EAAA,OAAO,MAAA;AACT;AAEA,eAAe,QAAA,CAAS,IAAA,EAAc,EAAA,EAAY,WAAA,EAAoC;AACpF,EAAA,MAAM,UAAU,MAAMC,gBAAA,CAAQ,MAAM,EAAE,aAAA,EAAe,MAAM,CAAA;AAC3D,EAAA,KAAA,MAAW,SAAS,OAAA,EAAS;AAC3B,IAAA,MAAM,GAAA,GAAMN,SAAA,CAAK,IAAA,EAAM,KAAA,CAAM,IAAI,CAAA;AACjC,IAAA,MAAM,IAAA,GAAOA,SAAA,CAAK,EAAA,EAAI,KAAA,CAAM,IAAI,CAAA;AAChC,IAAA,IAAI,KAAA,CAAM,aAAY,EAAG;AACvB,MAAA,MAAMK,cAAA,CAAM,IAAA,EAAM,EAAE,SAAA,EAAW,MAAM,CAAA;AACrC,MAAA,MAAM,QAAA,CAAS,GAAA,EAAK,IAAA,EAAM,WAAW,CAAA;AAAA,IACvC,CAAA,MAAO;AACL,MAAA,IAAI,IAAA,GAAO,MAAME,iBAAA,CAAS,GAAA,EAAK,MAAM,CAAA;AACrC,MAAA,IAAA,GAAO,IAAA,CAAK,UAAA,CAAW,gBAAA,EAAkB,WAAW,CAAA;AACpD,MAAA,MAAMC,kBAAA,CAAU,IAAA,EAAM,IAAA,EAAM,MAAM,CAAA;AAAA,IACpC;AAAA,EACF;AACF","file":"index.cjs","sourcesContent":["import { mkdir, readdir, readFile, writeFile } from \"node:fs/promises\";\nimport { basename, dirname, join, resolve } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), \"..\");\n\nexport const TEMPLATE_DIR = join(PROJECT_ROOT, \"template\");\n\nexport async function scaffold(targetDir: string): Promise<string> {\n const target = resolve(targetDir);\n const projectName = basename(target);\n await mkdir(target, { recursive: true });\n await copyTree(TEMPLATE_DIR, target, projectName);\n return target;\n}\n\nasync function copyTree(from: string, to: string, projectName: string): Promise<void> {\n const entries = await readdir(from, { withFileTypes: true });\n for (const entry of entries) {\n const src = join(from, entry.name);\n const dest = join(to, entry.name);\n if (entry.isDirectory()) {\n await mkdir(dest, { recursive: true });\n await copyTree(src, dest, projectName);\n } else {\n let data = await readFile(src, \"utf8\");\n data = data.replaceAll(\"<PACKAGE_NAME>\", projectName);\n await writeFile(dest, data, \"utf8\");\n }\n }\n}\n"]}
|
package/dist/index.d.cts
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}
|
package/package.json
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "bun-api-starter",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Scaffold a modern Bun + Elysia REST API with one command. Type-safe routes, zero configuration.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"bun",
|
|
7
|
+
"elysia",
|
|
8
|
+
"api",
|
|
9
|
+
"rest",
|
|
10
|
+
"starter",
|
|
11
|
+
"scaffold",
|
|
12
|
+
"boilerplate",
|
|
13
|
+
"create",
|
|
14
|
+
"typescript",
|
|
15
|
+
"server"
|
|
16
|
+
],
|
|
17
|
+
"license": "MIT",
|
|
18
|
+
"author": {
|
|
19
|
+
"name": "Razi",
|
|
20
|
+
"url": "https://github.com/knownasrazi"
|
|
21
|
+
},
|
|
22
|
+
"type": "module",
|
|
23
|
+
"bin": {
|
|
24
|
+
"create-bun-api": "./dist/cli.js"
|
|
25
|
+
},
|
|
26
|
+
"main": "./dist/index.cjs",
|
|
27
|
+
"module": "./dist/index.js",
|
|
28
|
+
"types": "./dist/index.d.ts",
|
|
29
|
+
"exports": {
|
|
30
|
+
".": {
|
|
31
|
+
"import": {
|
|
32
|
+
"types": "./dist/index.d.ts",
|
|
33
|
+
"default": "./dist/index.js"
|
|
34
|
+
},
|
|
35
|
+
"require": {
|
|
36
|
+
"types": "./dist/index.d.cts",
|
|
37
|
+
"default": "./dist/index.cjs"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
"files": [
|
|
42
|
+
"dist",
|
|
43
|
+
"template"
|
|
44
|
+
],
|
|
45
|
+
"engines": {
|
|
46
|
+
"node": ">=18",
|
|
47
|
+
"bun": ">=1.0"
|
|
48
|
+
},
|
|
49
|
+
"sideEffects": false,
|
|
50
|
+
"scripts": {
|
|
51
|
+
"build": "tsup",
|
|
52
|
+
"test": "bun test",
|
|
53
|
+
"typecheck": "tsc --noEmit",
|
|
54
|
+
"lint": "biome check --diagnostic-level=warn .",
|
|
55
|
+
"format": "biome format --write .",
|
|
56
|
+
"release": "bun run lint && bun run typecheck && bun run build && bun test"
|
|
57
|
+
},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@biomejs/biome": "^2.5.7",
|
|
60
|
+
"@types/bun": "^1.2.0",
|
|
61
|
+
"tsup": "^8.5.1",
|
|
62
|
+
"typescript": "^5.9.0"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
PORT=5000
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# <PACKAGE_NAME>
|
|
2
|
+
|
|
3
|
+
A Bun + Elysia API scaffolded with [bun-api-starter](https://github.com/knownasrazi/bun-api-starter).
|
|
4
|
+
|
|
5
|
+
## setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
cp .env.example .env # optional, PORT defaults to 5000
|
|
9
|
+
bun install
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## run
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
bun run dev # watch mode
|
|
16
|
+
bun run start # production
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## routes
|
|
20
|
+
|
|
21
|
+
- `GET /` - service info
|
|
22
|
+
- `GET /health` - health check
|
|
23
|
+
|
|
24
|
+
Every file under `src/routes/` exports an `Elysia` instance; mount them in `src/server.ts` with `.use(...)`.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://biomejs.dev/schemas/2.5.12/schema.json",
|
|
3
|
+
"files": {
|
|
4
|
+
"includes": ["**", "!**/dist", "!**/coverage", "!**/node_modules", "!**/bun.lock"]
|
|
5
|
+
},
|
|
6
|
+
"formatter": {
|
|
7
|
+
"enabled": true,
|
|
8
|
+
"indentStyle": "space",
|
|
9
|
+
"indentWidth": 2,
|
|
10
|
+
"lineWidth": 120,
|
|
11
|
+
"formatWithErrors": false
|
|
12
|
+
},
|
|
13
|
+
"linter": {
|
|
14
|
+
"enabled": true,
|
|
15
|
+
"rules": {
|
|
16
|
+
"preset": "recommended"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"javascript": {
|
|
20
|
+
"formatter": {
|
|
21
|
+
"quoteStyle": "double",
|
|
22
|
+
"semicolons": "always",
|
|
23
|
+
"trailingCommas": "all"
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "<PACKAGE_NAME>",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"private": true,
|
|
6
|
+
"scripts": {
|
|
7
|
+
"dev": "bun --watch src/server.ts",
|
|
8
|
+
"start": "bun src/server.ts",
|
|
9
|
+
"lint": "biome check .",
|
|
10
|
+
"typecheck": "tsc --noEmit",
|
|
11
|
+
"format": "biome format --write ."
|
|
12
|
+
},
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"@dotenvx/dotenvx": "^1.40.2",
|
|
15
|
+
"elysia": "^1.4.29"
|
|
16
|
+
},
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"@biomejs/biome": "^2.5.7",
|
|
19
|
+
"@types/bun": "^1.2.2",
|
|
20
|
+
"typescript": "^5.9.0"
|
|
21
|
+
}
|
|
22
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import "@dotenvx/dotenvx/config";
|
|
2
|
+
import { Client } from "seyfert";
|
|
3
|
+
|
|
4
|
+
const client = new Client({
|
|
5
|
+
intents: ["Guilds", "GuildMembers", "GuildMessages", "MessageContent"],
|
|
6
|
+
locations: {
|
|
7
|
+
base: "src",
|
|
8
|
+
commands: "commands",
|
|
9
|
+
},
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
client.once("ready", () => {
|
|
13
|
+
console.log("[seyfert] bot is online");
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
void client.start();
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import "@dotenvx/dotenvx/config";
|
|
2
|
+
import { Elysia } from "elysia";
|
|
3
|
+
import { health } from "./routes/health";
|
|
4
|
+
|
|
5
|
+
const port = Number(process.env.PORT ?? 5000);
|
|
6
|
+
|
|
7
|
+
const app = new Elysia()
|
|
8
|
+
.get("/", () => ({ name: "<PACKAGE_NAME>", status: "online" }))
|
|
9
|
+
.use(health);
|
|
10
|
+
|
|
11
|
+
app.listen(port);
|
|
12
|
+
|
|
13
|
+
console.log(`api up at http://localhost:${port}`);
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"module": "ESNext",
|
|
5
|
+
"moduleResolution": "bundler",
|
|
6
|
+
"types": ["@types/bun"],
|
|
7
|
+
"strict": true,
|
|
8
|
+
"noUncheckedIndexedAccess": true,
|
|
9
|
+
"verbatimModuleSyntax": true,
|
|
10
|
+
"esModuleInterop": true,
|
|
11
|
+
"forceConsistentCasingInFileNames": true,
|
|
12
|
+
"skipLibCheck": true,
|
|
13
|
+
"noEmit": true
|
|
14
|
+
},
|
|
15
|
+
"include": ["src"]
|
|
16
|
+
}
|