Docs: Bringing clarity to the introduction docs #343
Conversation
| To learn more about the CLI, check out the [Using the CLI](/usage/cli) guide. | ||
| This will create a local `data.db` SQLite database file in the folder you ran the command and start the bknd web server at http://localhost:1337. | ||
|
|
||
| Right now the admin dashboard is not locked down (AKA "guarded"), which means anyone who can access your dashboard will be able to update the configuration and change data in your entities. To prevent unauthorized use, let's put a guard on your bknd instance. |
There was a problem hiding this comment.
I think "right now" is misleading, it's intentionally open, as all APIs are designed to be opt-in. Do you think it to follow a "sane defaults" path instead?
There was a problem hiding this comment.
I agree that prior copy felt misleading. I've updated the copy to reflect the opt-in, open philosophy.
re: "Do you think it to follow a "sane defaults" path instead?"
future idea: I think one thing we can add to the admin dashboard is to prevent enabling the guard if there's no admin-level roles and/or if there's no users with said admin-level role. I know that the guard is prevented when there's no admin-level roles, but not if there's no users with that role
There was a problem hiding this comment.
Yes agree, this makes sense!
| bknd is incredibly lightweight and built upon Web Standards, so that you can bring bknd anywhere JavaScript runs. | ||
|
|
||
| ## Preview | ||
| Bring your [favorite frontend](./#start-with-a-frameworkruntime) and [favorite SQL database](./#use-your-favorite-sql-database), and we'll bring the bknd. |
There was a problem hiding this comment.
kinda nice pun, maybe: "... and we'll bring the backend bknd."?
2 participants
This is my attempt at cleaning up the bknd docs one doc at a time, starting with the introduction docs.
I've gained inspiration from https://pocketbase.io/docs/, https://trailbase.io/getting-started/install, and https://www.instantdb.com/docs.
OLD
NEW