shishantbiswas/bknd
1
0
Fork 0
mirror of https://github.com/shishantbiswas/bknd.git synced 2026-03-15 20:17:22 +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

34
examples/astro/README.md
View File

@@ -1,16 +1,7 @@
# Astro Starter Kit: Minimal
# bknd starter: Astro
A minimal Astro project with bknd integration.
```sh
npm create astro@latest -- --template minimal
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
## Project Structure
Inside of your Astro project, you'll see the following folders and files:
@@ -19,17 +10,18 @@ Inside of your Astro project, you'll see the following folders and files:
├── public/
├── src/
│ └── pages/
│ └── index.astro
│ └── admin/
│ │ └── [...admin].astro
│ └── api/
│ │ └── [...api].astro
│ ├── index.astro
│ └── ssr.astro
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
To update `bknd` config, check `src/api/[...api].astro` and `src/admin/[...admin].astro`.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
## Commands
All commands are run from the root of the project, from a terminal:
@@ -42,6 +34,6 @@ All commands are run from the root of the project, from a terminal:
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
## Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
Feel free to check [our documentation](https://docs.bknd.io/integration/astro) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).