mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 04:27:21 +00:00
update nextjs example's readme
This commit is contained in:
@@ -1,36 +1,45 @@
|
|||||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
# bknd starter: Next.js
|
||||||
|
A minimal Next.js (app router) 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
|
```text
|
||||||
npm run dev
|
/
|
||||||
# or
|
├── ...
|
||||||
yarn dev
|
├── public
|
||||||
# or
|
├── src
|
||||||
pnpm dev
|
│ ├── app
|
||||||
# or
|
│ │ ├── (main)
|
||||||
bun dev
|
│ │ │ └── ...
|
||||||
|
│ │ ├── admin
|
||||||
|
│ │ │ └── [[...admin]]
|
||||||
|
│ │ │ └── page.tsx
|
||||||
|
│ │ ├── api
|
||||||
|
│ │ │ └── [[...bknd]]
|
||||||
|
│ │ │ └── route.ts
|
||||||
|
│ │ └── ...
|
||||||
|
│ └── bknd.ts
|
||||||
|
└── package.json
|
||||||
```
|
```
|
||||||
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
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`
|
||||||
|
|
||||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
## Commands
|
||||||
|
|
||||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
All commands are run from the root of the project, from a terminal:
|
||||||
|
|
||||||
## Learn More
|
| 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 |
|
||||||
|
|
||||||
To learn more about Next.js, take a look at the following resources:
|
## Want to learn more?
|
||||||
|
|
||||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
Feel free to check [our documentation](https://docs.bknd.io/integration/nextjs) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).
|
||||||
- [Learn Next.js](https://nextjs.org/learn) - 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/app/building-your-application/deploying) for more details.
|
|
||||||
Reference in New Issue
Block a user