https://github.com/treeder/flaregun-starter
Starter kit for full stack apps on Cloudflare developer platform. No framework lock-in.
https://github.com/treeder/flaregun-starter
Last synced: 5 months ago
JSON representation
Starter kit for full stack apps on Cloudflare developer platform. No framework lock-in.
- Host: GitHub
- URL: https://github.com/treeder/flaregun-starter
- Owner: treeder
- License: apache-2.0
- Created: 2025-06-20T17:11:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-15T07:53:51.000Z (5 months ago)
- Last Synced: 2026-01-15T14:36:36.203Z (5 months ago)
- Language: JavaScript
- Size: 634 KB
- Stars: 22
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flaregun Starter Kit
This is a starter kit for running a full-stack app quickly on Cloudflare without a complex framework. Pure JavaScript and standard technology to prevent lock-in.
Super lightweight, super fast, easy to understand, no magic (well, just a little). Uses [flaregun](https://github.com/treeder/flaregun) for an awesome Cloudflare experience.
Out of the box, this includes:
- database with easy migrations
- file storage
- server side rendering
- API endpoints
- queues
- scheduler
- material 3 web components
- email and passkey authentication
It's easy to add and remove things since it's mostly just standard JavaScript.
## Getting started
You can get up and running in seconds (literally).
### Deploy to Cloudflare
Want to deploy in seconds to see it in action?
[](https://deploy.workers.cloudflare.com/?url=https://github.com/treeder/flaregun-starter)
### Run locally for development
Click `Use this template` button in the top right:
Then clone and run your new repo:
```sh
npm start
```
Now view the demo page at http://localhost:8787.
Try making some changes and see it update in real-time!
## Database
### Schema / migrations
Define models [models](https://github.com/treeder/models) in the [data](./functions/data) folder, then add the class to [migrations.js](./functions/data/migrations.js) to automatically keep your database schema up to date.
### Using the database
It's super easy to use the database:
```js
let user = { name: 'John Wick', email: 'x@y.com' }
await c.data.d1.insert('users', user)
user.name = 'Jim Bean'
// update a row
await c.data.d1.update('users', user.id, user)
// get object
user = c.data.d1.get('users', user.id)
// querying
let users = await c.data.d1.query('users', {
where: { email: 'x@y.com' },
})
```
See the [D1 docs](https://github.com/treeder/flaregun/blob/main/README.md#d1-sqlite-database) in the flaregun for more complex examples.
## Layout
Edit [layout.js](./functions/layout.js) to update the layout of your app.
## Routes
This uses file based routing from [Cloudflare Pages Functions](https://developers.cloudflare.com/pages/functions/routing/), but runs on Workers because Pages Functions are deprecated.
To add a new route, just add a new file to the functions directory and that will be your route. For instance, if you add a file called `hello.js`, it will be available at
`/hello`.
For UI endpoints:
```js
import { html } from 'rend'
export async function onRequestGet(c) {
return await c.data.rend.html({
main: render,
})
}
function render(d) {
return html`
Hello world! `
}
```
For API endpoints:
```js
export async function onRequestGet(c) {
return Response.json({
hello: 'world',
})
}
```
## Scheduler
The [scheduled.js](functions/scheduled.js) file will run every minute by default (after your first deployment).
To disable scheduling, delete the scheduled.js file and remove the triggers from wrangler.jsonc.
NOTE: There are some small gotchas here:
- This won't run any middleware, so you'll have to do any initialization you need in the scheduled function.
- To import something like a class or function in scheduled.js, it must also be used elsewhere in your app.
That's about it, otherwise, should work as is!
## Queues
The [queue.js](functions/queue.js) file will run whenever you post a message to the queue.
To post a message:
```js
await c.env.QUEUE.send({ message: 'Hello, world!' })
```
Your queue.js handler will get the message shortly.
To delay the message:
```js
await c.env.QUEUE.send({ message: 'Hello, world!' }, { delaySeconds: 60 })
```
That will delay the message for 60 seconds.
## Testing
This is configured to do some basic API testing with [testkit](https://github.com/treeder/testkit). See [tests/tests.js](tests/tests.js) for more details. Run tests with `npm run testkit` and you can add that to your CI.
## Deploying
This is two steps.
1. Run setup script to create all the resources on Cloudflare.
2. Deploy!
### Setup
This will create all your cloudflare resources such as your database and file storage.
- First get an [API token for Cloudflare](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) and get your account ID.
- Choose "Edit Cloudflare Workers" template.
Keep all the same settings, but also add D1 with write access.
Create a `.env` file with:
```sh
CLOUDFLARE_API_TOKEN=X
CLOUDFLARE_ACCOUNT_ID=Y
```
Then run:
```sh
npm run setup
```
### Manual deploy
To deploy to dev environment:
```sh
npm run deploy
```
To deploy to prod environment:
```sh
npm run deploy:prod
```
### Auto deploy
Setup auto deploy in the Cloudflare Dashboard so every commit to main will deploy and other
branches will get a preview URL.
Set build command to:
```sh
npm run build
```
Set deploy command to:
```sh
npm run deploy
```
Set non-production branch deploy command to:
```sh
npm run deploy:preview
```
### Deploying to production
```sh
npm run deploy:prod
```
Then your auto deploy configuration should change to:
- `npm run build`
- `npm run deploy:prod`
- Preview URLs: You may not want to have preview URLs on production, but if you do, use: `npm run deploy:prod:preview`.