-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added readme and updated preview image
- Loading branch information
1 parent
63f3dda
commit d091c6f
Showing
2 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
![sidebase website](./.github/preview.png) | ||
|
||
# sidebase docs | ||
|
||
The sidebase homepage (https://sidebase.io), including the documentation for the sidebase development kit. | ||
|
||
## Quick start | ||
|
||
1. Clone the repository | ||
```sh | ||
git clone https://github.com/sidebase/docs | ||
``` | ||
2. Install the dependencies | ||
```sh | ||
pnpm install | ||
``` | ||
3. Start developing (with [vitepress](https://vitepress.dev/)) at [localhost:5173](http://localhost:5173) | ||
```sh | ||
pnpm dev | ||
``` | ||
|
||
## Contributing | ||
|
||
This repository only contains: | ||
|
||
- The sidebase.io homepage | ||
- The sidebase development kit documentation | ||
- Redirects from previous documentation to their respective new sites | ||
|
||
If you would like to edit the documentation to one of our modules, please visit their respective repositories | ||
|
||
- [@sidebase/nuxt-auth](https://github.com/sidebase/nuxt-auth) |