shishantbiswas/bknd
1
0
Fork 0
mirror of https://github.com/shishantbiswas/bknd.git synced 2026-03-16 04:27:21 +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

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).