mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 04:27:21 +00:00
59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
# bknd starter: Solid Start
|
|
A minimal example of a Solid Start project with bknd integration.
|
|
|
|
## Project Structure
|
|
|
|
Inside of your Solid Start project, you'll see the following folders and files:
|
|
|
|
```text
|
|
.
|
|
├── bknd.config.ts
|
|
├── bun.lock
|
|
├── package.json
|
|
├── public
|
|
│ ├── admin # generated by bknd and contains the admin UI
|
|
│ ├── bknd.ico
|
|
│ ├── bknd.svg
|
|
│ ├── file.svg
|
|
│ ├── globe.svg
|
|
│ ├── solid.svg
|
|
│ └── window.svg
|
|
├── README.md # you're here
|
|
├── src
|
|
│ ├── app.css
|
|
│ ├── app.tsx
|
|
│ ├── components
|
|
│ │ ├── Footer.tsx
|
|
│ │ └── List.tsx
|
|
│ ├── entry-client.tsx
|
|
│ ├── entry-server.tsx
|
|
│ ├── global.d.ts
|
|
│ ├── lib
|
|
│ │ └── bknd.ts # initializes bknd instance
|
|
│ ├── middleware
|
|
│ │ └── index.ts # mounts bknd middleware
|
|
│ └── routes
|
|
│ ├── [...404].tsx
|
|
│ ├── index.tsx
|
|
│ └── user.tsx
|
|
├── tsconfig.json
|
|
└── vite.config.ts
|
|
```
|
|
|
|
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/lib/bknd.ts`
|
|
* Admin UI is rendered using `src/middleware/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 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/solid-start) or jump into our [Discord server](https://discord.gg/952SFk8Tb8). |