mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 20:37:21 +00:00
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
# bknd starter: Next.js
|
|
A minimal Next.js (app router) project with bknd integration.
|
|
|
|
## Project Structure
|
|
|
|
Inside of your Next.js project, you'll see the following folders and files:
|
|
|
|
```text
|
|
/
|
|
├── ...
|
|
├── public
|
|
├── src
|
|
│ ├── app
|
|
│ │ ├── (main)
|
|
│ │ │ └── ...
|
|
│ │ ├── admin
|
|
│ │ │ └── [[...admin]]
|
|
│ │ │ └── page.tsx
|
|
│ │ ├── api
|
|
│ │ │ └── [[...bknd]]
|
|
│ │ │ └── route.ts
|
|
│ │ └── ...
|
|
│ └── bknd.ts
|
|
└── package.json
|
|
```
|
|
|
|
Here is a quick overview about how to adjust the behavior of `bknd`:
|
|
* Initialization of the `bknd` config with helper functions are located at `src/bknd.ts`
|
|
* API routes are exposed at `src/api/[[...bknd]]/route.ts`
|
|
* Admin UI is rendered at `src/admin/[[...admin]]/page.tsx`
|
|
|
|
## 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:3000` |
|
|
| `npm run dev:turbo` | Starts a local turso dev server |
|
|
| `npm run build` | Build your production site |
|
|
|
|
## Want to learn more?
|
|
|
|
Feel free to check [our documentation](https://docs.bknd.io/integration/nextjs) or jump into our [Discord server](https://discord.gg/952SFk8Tb8). |