mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 04:27:21 +00:00
doc update: added db setup instructions
This commit is contained in:
@@ -33,6 +33,7 @@ Bun.serve({
|
|||||||
|
|
||||||
console.log("Server running at http://localhost:1337");
|
console.log("Server running at http://localhost:1337");
|
||||||
```
|
```
|
||||||
|
For more information about the connection object, refer to the [Setup](/setup) guide.
|
||||||
|
|
||||||
Run the application using Bun by executing:
|
Run the application using Bun by executing:
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -11,8 +11,8 @@ and then install bknd as a dependency:
|
|||||||
|
|
||||||
<InstallBknd />
|
<InstallBknd />
|
||||||
|
|
||||||
## Serve the API
|
|
||||||
|
|
||||||
|
## Serve the API
|
||||||
``` ts
|
``` ts
|
||||||
import { serve } from "bknd/adapter/cloudflare";
|
import { serve } from "bknd/adapter/cloudflare";
|
||||||
|
|
||||||
@@ -30,6 +30,7 @@ export default serve(
|
|||||||
}
|
}
|
||||||
);
|
);
|
||||||
```
|
```
|
||||||
|
For more information about the connection object, refer to the [Setup](/setup) guide.
|
||||||
|
|
||||||
Now run the worker:
|
Now run the worker:
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -33,6 +33,7 @@ export default serve({
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
For more information about the connection object, refer to the [Setup](/setup) guide.
|
||||||
|
|
||||||
## Enabling the Admin UI
|
## Enabling the Admin UI
|
||||||
Create a file `[[...admin]].tsx` inside the `pages/admin` folder:
|
Create a file `[[...admin]].tsx` inside the `pages/admin` folder:
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ const handler = serve({
|
|||||||
export const loader = handler;
|
export const loader = handler;
|
||||||
export const action = handler;
|
export const action = handler;
|
||||||
```
|
```
|
||||||
|
For more information about the connection object, refer to the [Setup](/setup) guide.
|
||||||
|
|
||||||
## Enabling the Admin UI
|
## Enabling the Admin UI
|
||||||
Create a new splat route file at `app/routes/admin.$.tsx`:
|
Create a new splat route file at `app/routes/admin.$.tsx`:
|
||||||
|
|||||||
@@ -72,7 +72,7 @@
|
|||||||
"navigation": [
|
"navigation": [
|
||||||
{
|
{
|
||||||
"group": "Getting Started",
|
"group": "Getting Started",
|
||||||
"pages": ["introduction", "installation"]
|
"pages": ["introduction", "setup"]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"group": "Modules",
|
"group": "Modules",
|
||||||
|
|||||||
61
docs/setup.mdx
Normal file
61
docs/setup.mdx
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
---
|
||||||
|
title: 'Setup'
|
||||||
|
description: 'Preparing your environment for bknd'
|
||||||
|
---
|
||||||
|
import InstallBknd from '/snippets/install-bknd.mdx';
|
||||||
|
|
||||||
|
In order to use **bknd**, you need to prepare access information to your database and install
|
||||||
|
the dependencies.
|
||||||
|
|
||||||
|
<Note>
|
||||||
|
Connections to the database are managed using Kysely. Therefore, all its dialects are
|
||||||
|
theoretically supported. However, only the `SQLite` dialect is implemented as of now.
|
||||||
|
</Note>
|
||||||
|
|
||||||
|
## Database
|
||||||
|
### SQLite as file
|
||||||
|
The easiest to get started is using SQLite as a file. When serving the API in the "Integrations",
|
||||||
|
the function accepts an object with connection details. To use a file, use the following:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "sqlite",
|
||||||
|
"config": {
|
||||||
|
"file": "path/to/your/database.db"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Please note that using SQLite as a file is only supported in server environments.
|
||||||
|
|
||||||
|
### SQLite using LibSQL
|
||||||
|
Turso offers a SQLite-fork called LibSQL that runs a server around your SQLite database. To
|
||||||
|
point **bknd** to a local instance of LibSQL, [install Turso's CLI](https://docs.turso.tech/cli/introduction) and run the following command:
|
||||||
|
```bash
|
||||||
|
turso dev
|
||||||
|
```
|
||||||
|
|
||||||
|
The command will yield a URL. Use it in the connection object:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "libsql",
|
||||||
|
"config": {
|
||||||
|
"url": "http://localhost:8080"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### SQLite using LibSQL on Turso
|
||||||
|
If you want to use LibSQL on Turso, [sign up for a free account](https://turso.tech/), create a database and point your
|
||||||
|
connection object to your new database:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "libsql",
|
||||||
|
"config": {
|
||||||
|
"url": "libsql://your-database-url.turso.io",
|
||||||
|
"authToken": "your-auth-token"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
To install **bknd**, run the following command:
|
||||||
|
<InstallBknd />
|
||||||
Reference in New Issue
Block a user