|
1 | | -# startkit/typescript |
| 1 | +# Build-a-Bank |
2 | 2 |
|
3 | | -A sane way to start your next TypeScript project. Fast, strict, and minimal. |
| 3 | + |
4 | 4 |
|
5 | | -## What's included |
6 | | - |
7 | | -| Tool | Purpose | |
8 | | -| -------------------------------------------------- | ------------------------ | |
9 | | -| [Bun](https://bun.sh) | Runtime, test runner | |
10 | | -| [tsdown](https://tsdown.dev) | Build (rolldown-based) | |
11 | | -| [oxlint](https://oxc.rs/docs/guide/usage/linter) | Linting (type-aware) | |
12 | | -| [oxfmt](https://oxc.rs/docs/guide/usage/formatter) | Formatting | |
13 | | -| TypeScript 5 | Strict mode, all the way | |
14 | | - |
15 | | -No ESLint. No Prettier. No slow tooling. |
16 | | - |
17 | | -## Getting started |
18 | | - |
19 | | -```bash |
20 | | -# Install dependencies |
21 | | -bun install |
22 | | - |
23 | | -# Run the app |
24 | | -bun dev |
25 | | - |
26 | | -# Build for production |
27 | | -bun run build |
28 | | - |
29 | | -# Run the built output |
30 | | -bun start |
31 | | -``` |
32 | | - |
33 | | -## Scripts |
34 | | - |
35 | | -```bash |
36 | | -bun run check # Run all checks (format, lint, typecheck, test) |
37 | | -bun run fix # Auto-fix format and lint issues |
38 | | -bun run typecheck # TypeScript type checking |
39 | | -bun run lint # Lint with type-aware rules |
40 | | -bun run format # Format with oxfmt |
41 | | -bun test # Run tests |
42 | | -bun run outdated # Interactive dependency updates |
43 | | -bun run clean # Clean build caches |
44 | | -bun run nuke # Clean everything including node_modules |
45 | | -``` |
46 | | - |
47 | | -## Project structure |
48 | | - |
49 | | -``` |
50 | | -src/ |
51 | | - index.ts # Entry point |
52 | | -tsconfig.json # Strict TypeScript config |
53 | | -.oxlintrc.json # Linter config (correctness: error, perf: warn) |
54 | | -.oxfmtrc.jsonc # Formatter config (no semis, double quotes) |
55 | | -``` |
56 | | - |
57 | | -## Conventions |
58 | | - |
59 | | -- Strict TypeScript -- no `any`, no `as` casts |
60 | | -- No semicolons, double quotes |
61 | | -- Imports are auto-sorted |
62 | | -- Tests use `bun:test` |
| 5 | +> [Agent Skills](https://skills.md) to let your AI Agent be their own bank. |
63 | 6 |
|
64 | 7 | ## License |
65 | 8 |
|
|
0 commit comments