mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-17 12:56:05 +00:00
updated examples package.json's and README.md's
This commit is contained in:
@@ -1 +1,34 @@
|
||||
# Remix & bknd
|
||||
# bknd starter: Remix
|
||||
A minimal Remix project with bknd integration.
|
||||
|
||||
## Project Structure
|
||||
|
||||
Inside of your Remix project, you'll see the following folders and files:
|
||||
|
||||
```text
|
||||
/
|
||||
├── public/
|
||||
├── app/
|
||||
│ ├── root.tsx
|
||||
│ └── routes/
|
||||
│ ├── _index.tsx
|
||||
│ ├── admin.$.tsx
|
||||
│ └── api.$.tsx
|
||||
└── package.json
|
||||
```
|
||||
|
||||
To update `bknd` config, check `app/routes/api.$.ts` and `app/routes/admin.$.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:5173` |
|
||||
| `npm run build` | Build your production site |
|
||||
|
||||
## Want to learn more?
|
||||
|
||||
Feel free to check [our documentation](https://docs.bknd.io/integration/remix) or jump into our [Discord server](https://discord.gg/952SFk8Tb8).
|
||||
|
||||
Reference in New Issue
Block a user