init: nuxt adapter

examples/nuxt/README.md

@@ -0,0 +1,64 @@
+# bknd starter: Nuxt
+A minimal example of a Nuxt project with bknd integration.
+
+## Project Structure
+
+Inside of your Nuxt project, you'll see the following folders and files:
+
+```text
+.
+├── app
+│   ├── assets
+│   │   └── css
+│   ├── components
+│   │   ├── Buttons.vue
+│   │   ├── Footer.vue
+│   │   └── List.vue
+│   ├── composables
+│   │   ├── useTodoActions.ts
+│   │   └── useUser.ts
+│   └── pages
+│       ├── index.vue
+│       └── user.vue
+├── bknd.config.ts
+├── bun.lock
+├── nuxt.config.ts
+├── package.json
+├── public
+│   ├── admin # generated by bknd and contains the admin UI
+│   ├── bknd.ico
+│   ├── bknd.svg
+│   ├── favicon.ico
+│   ├── file.svg
+│   ├── globe.svg
+│   ├── nuxt.svg
+│   ├── robots.txt
+│   └── window.svg
+├── README.md
+├── server
+│   ├── middleware
+│   │   └── bknd.ts # intercepts api and admin ui requests
+│   ├── routes
+│   │   └── todos.post.ts
+│   └── utils
+│       └── bknd.ts # initializes bknd instance
+└── tsconfig.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/server/utils/bknd.ts`
+* Admin UI is rendered at `src/server/middleware/bknd.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:3000`      |
+| `npm run build`           | Build your production site                       |
+
+## Want to learn more?
+
+Feel free to check [our documentation](https://docs.bknd.io/integration/nuxt) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).