shishantbiswas/bknd
1
0
Fork 0
mirror of https://github.com/shishantbiswas/bknd.git synced 2026-03-15 20:17:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated examples package.json's and README.md's

Browse Source
This commit is contained in:
dswbx
2025-02-18 13:19:35 +01:00
parent 7994eabe7d
commit 964bacd824
8 changed files with 163 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
examples/astro/README.md
View File

@@ -1,16 +1,7 @@
# Astro Starter Kit: Minimal
# bknd starter: Astro
A minimal Astro project with bknd integration.
```sh
npm create astro@latest -- --template minimal
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
## Project Structure
Inside of your Astro project, you'll see the following folders and files:
@@ -19,17 +10,18 @@ Inside of your Astro project, you'll see the following folders and files:
├── public/
├── src/
│ └── pages/
│ └── index.astro
│ └── admin/
│ │ └── [...admin].astro
│ └── api/
│ │ └── [...api].astro
│ ├── index.astro
│ └── ssr.astro
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
To update `bknd` config, check `src/api/[...api].astro` and `src/admin/[...admin].astro`.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
## Commands
All commands are run from the root of the project, from a terminal:
@@ -42,6 +34,6 @@ All commands are run from the root of the project, from a terminal:
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
## Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
Feel free to check [our documentation](https://docs.bknd.io/integration/astro) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

31
examples/bun/README.md
View File

@@ -1,15 +1,28 @@
# bun
# bknd starter: Bun
A minimal Bun project with bknd integration.
To install dependencies:
## Project Structure
```bash
bun install
Inside of your Bun project, you'll see the following folders and files:
```text
/
├── index.ts
├── minimal.ts
└── package.json
```
To run:
To update `bknd` config, check `index.ts`.
```bash
bun run index.ts
```
## Commands
This project was created using `bun init` in bun v1.1.34. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:--------------------------|:--------------------------------------------|
| `bun install` | Installs dependencies |
| `bun run dev` | Starts local dev server at `localhost:3000` |
## Want to learn more?
Feel free to check [our documentation](https://docs.bknd.io/integration/bun) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

37
examples/cloudflare-worker/README.md Normal file
View File

@@ -0,0 +1,37 @@
# bknd starter: Cloudflare Workers
A minimal Node.js project with bknd integration.
## Project Structure
Inside of your Node.js project, you'll see the following folders and files:
```text
/
├── src/
│ └── index.ts
├── package.json
└── wrangler.json
```
To update `bknd` config, check `src/index.ts`.
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:------------------|:---------------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server with `watch` at `localhost:8787` |
| `npm run typegen` | Generates wrangler types |
## Before you deploy
If you're using a D1 database, make sure to create a database in your cloudflare account and replace the `database_id` accordingly in `wrangler.json`.
```sh
npx wrangler d1 create my-database
```
## Want to learn more?
Feel free to check [our documentation](https://docs.bknd.io/integration/cloudflare) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

3
examples/cloudflare-worker/package.json
View File

@@ -5,8 +5,7 @@
"scripts": {
"deploy": "wrangler deploy",
"dev": "wrangler dev",
"start": "wrangler dev",
"cf-typegen": "wrangler types"
"typegen": "wrangler types"
},
"dependencies": {
"bknd": "file:../../app",

58
examples/nextjs/README.md
View File

@@ -1,40 +1,38 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/pages/api-reference/create-next-app).
# bknd starter: Next.js
A minimal Next.js project with bknd integration.
## Getting Started
## Project Structure
First, run the development server:
Inside of your Next.js project, you'll see the following folders and files:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```text
/
├── public/
├── src/
│ └── pages/
│ └── admin/
│ │ └── [[...admin]].tsx
│ └── api/
│ │ └── [...route].ts
│ ├── _app.tsx
│ ├── _document.tsx
│ └── index.tsx
└── package.json
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
To update `bknd` config, check `src/pages/api/[...route].ts` and `src/pages/admin/[[...admin]].tsx`.
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
## Commands
[API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
All commands are run from the root of the project, from a terminal:
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) instead of React pages.
| Command | Action |
|:--------------------------|:-------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site |
| `npm run db` | Starts a local LibSQL database |
This project uses [`next/font`](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Want to learn more?
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/pages/building-your-application/deploying) for more details.
Feel free to check [our documentation](https://docs.bknd.io/integration/nextjs) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

28
examples/node/README.md Normal file
View File

@@ -0,0 +1,28 @@
# bknd starter: Node.js
A minimal Node.js project with bknd integration.
## Project Structure
Inside of your Node.js project, you'll see the following folders and files:
```text
/
├── index.js
└── package.json
```
To update `bknd` config, check `index.js`.
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:----------------|:---------------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server with `watch` at `localhost:3000` |
| `npm run start` | Starts local dev server at `localhost:3000` |
## Want to learn more?
Feel free to check [our documentation](https://docs.bknd.io/integration/node) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

35
examples/remix/README.md
View File

@@ -1 +1,34 @@
# Remix & bknd
# bknd starter: Remix
A minimal Remix project with bknd integration.
## Project Structure
Inside of your Remix project, you'll see the following folders and files:
```text
/
├── public/
├── app/
│ ├── root.tsx
│ └── routes/
│ ├── _index.tsx
│ ├── admin.$.tsx
│ └── api.$.tsx
└── package.json
```
To update `bknd` config, check `app/routes/api.$.ts` and `app/routes/admin.$.ts`.
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|:--------------------------|:--------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:5173` |
| `npm run build` | Build your production site |
## Want to learn more?
Feel free to check [our documentation](https://docs.bknd.io/integration/remix) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).

2
examples/remix/package.json
View File

@@ -6,8 +6,6 @@
"scripts": {
"build": "remix vite:build",
"dev": "remix vite:dev",
"db": "turso dev --db-file test.db",
"db:check": "sqlite3 test.db \"PRAGMA wal_checkpoint(FULL);\"",
"start": "remix-serve ./build/server/index.js",
"typecheck": "tsc"
},