Skip to content

Commit

Permalink
doc: add how to contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
invisal committed Jun 15, 2024
1 parent dbeec9c commit bf21b1b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,20 @@ Try [LibSQL Studio](https://libsqlstudio.com/) online here.
- Edit your table data in spreadsheet-like editor
- Query editor with basic syntax highlighting and basic auto complete
- Basic connection management

## How to contribute

To run the project

```
pnpm install
cd studio
pnpm run dev
```

**Folder structure**

| Folder | Description |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/gui` | This is standalone database GUI React component. It is not tied to any specific database driver, allowing users to extend and integrate it into their own projects with ease. |
| `/studio` | It is complete database GUI client as seen in https://libsqlstudio.com. Come with database drivers and many other features |

0 comments on commit bf21b1b

Please sign in to comment.