Stew — HTML 启动器模板

SHA-256: cd873d59f2099eeb165165fe8bf33750ef9036a5f34411c4f69c4157c8b382b6

2026-10-03T23:20:05.696Z

<div align=center>

<img src="./docs/stew.png" height=150px>

# STEW Starter

A minimal, high-performance project template built on my STEW.

I purpose-built this template for developers who want to stick to raw HTML and CSS, backed by the reliability of type-safe JavaScript, without dealing with complex frameworks or bloated tooling.

</div>

**Live Landing Page:** Check out the interactive demo page at [ichimakikasura.github.io/Stew/](https://ichimakikasura.github.io/Stew/)

> **Note:** This build tool is built entirely on my own preferences. It works exactly how I like to build, skipping the heavy setup and keeping things simple. Feel free to tweak it, tear it apart, or modify it your own way.
>
> **Contributions:** No issues will be accepted. As I mentioned above, if you want changes, you can fork it and modify it your own way. Pull request suggestions might be.

---

## Project Structure

```text
├── build/              # Custom compiler and bundler
├── src/                # Static site source and app assets
│   └── wrangler.jsonc  # Edge deployment configuration
├── ts/                 # Client-side TypeScript logic
├── api/                # Worker entrypoints
│   └── worker.js       # For production/live
├── package.json
├── tsconfig.json
├── wrangler.dev.json   # Local/Testing stage configuration
├── wrangler.prod.json  # Production test configuration
└── readme.md
```

---

### Docs

- [Overview](docs/overview.md)

---

## Local Testing & Workflows

Ensure you have Node.js installed, then clone the repository and install dependencies:

```bash
npm install
```

I included several custom utility pipelines depending on your development workflow:

#### Full Integration Test
To run my custom esbuild compiler watcher alongside the active Cloudflare Wrangler emulator concurrently:

```bash
npm run test:dev
```

#### Preivew Production build
This will build and launch a live server of your site in a production settings.

Though it lacks live reload but thats whats the `npm run test:site` for development :>

```bash
npm run test:prod
```

#### Available Build and Test Commands
- `npm run test:site`   — Initiates the site without the `api` integration.
- `npm run build:test`  — Compile TypeScript and execute the builder in test mode.
- `npm run build:ts`    — Run the raw TypeScript compiler.
- `npm run ts:watch`    — Use esbuild to watch and bundle client script changes directly into `src/js/`.
- `npm run test:ts`     — Run a deep, verbose diagnostic check on your TypeScript configurations.
- `npm run update:stew` — Updates the `build` folder only.

---

## Deployment Workflow

To prepare build artifacts for the live web, generate the optimized code output:

```bash
npm run build:prod
```

### If you want to make it live using Cloudflare:

#### 1. Frontend & Client-Side Assets
1. Navigate to your Cloudflare Dashboard and spin up a new Pages project.
2. Upload the newly generated production `dist/` directory and link it up to your domain.

#### 2. Backend API (Edge Worker)
1. Head over to Workers & Pages in your Cloudflare dashboard and create a new Worker.
2. Open your local `worker/worker.js` file and copy the native ES Module handler (`export default`).
3. Paste it directly into the Cloudflare online code editor, hit Save and Deploy, and you are live.

---

## Database & Storage

I don't lock this starter into any specific database layer. You are free to configure your data storage however you prefer (PostgreSQL, MongoDB, Supabase, etc.) via HTTP or WebSockets.

### My Recommended Native Options
If you are deploying to Cloudflare and want zero-cold-start performance, I highly recommend using their built-in data primitives:
- **Cloudflare D1** — A native serverless SQL database built on SQLite. Perfect for relational data.
- **Cloudflare KV** — A global, low-latency, key-value data store. Perfect for configurations, quick data caching, or session tracking.

To use them, simply hook up your bindings directly inside your `wrangler.json` / `wrangler.jsonc` configs.

---

## License

This project is licensed under the MIT License — feel free to use it for whatever you want.