Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zernonia/supabase-schema

Secured & Simple Supabase Schema Visualizer
https://github.com/zernonia/supabase-schema

database-schema supabase-schema typescript vite vue vueuse yarn

Last synced: 29 days ago
JSON representation

Secured & Simple Supabase Schema Visualizer

Awesome Lists containing this project

README

        





Logo

Supabase Schema


Secured & Simple Supabase Schema Visualizer.


No installations โ€ข No Database password required.




View Demo
ยท
Report Bug
ยท
Request Feature

![Supabase Schema](images/main.png)

## ๐Ÿš€ Features

- ๐Ÿ”จ No installations
- ๐Ÿ”’ Persistent State in LocalStorage
- ๐Ÿšช Login-less
- ๐Ÿ‘€ No Sensitive info required
- ๐Ÿคš Moveable Schema for own design

## ๐Ÿ“‡ About The Project

I look around the internet and found many Database Schema Visualizers that require me to either download the software, or login to view my Database Schema. I feel like there's too many unneccessary steps, just to view the schema.

Thus, I've decided to take this opportunity to build this **Open Source, Free, Login-less and Secured** Supabase Schema Visualizer ๐Ÿ”ฅ

### ๐Ÿ”จ Built With

- [Vue 3](https://v3.vuejs.org/)
- [Vite](https://vitejs.dev/)
- [WindiCSS](https://windicss.org/)

## ๐Ÿพ Instructions

1. Go to [Supabase App](https://app.supabase.io/)
2. Select your Project
3. Go to `Settings`
4. In Settings tab, Go to `API`
5. Under `Config`, copy `URL`
6. Under `API Keys`, copy `anon` `public`
7. Paste both value into their respectively slot in [Supabase Schema](https://supabase-schema.vercel.app/)
8. Fetch data
9. Enjoy the Visualization ๐ŸŽ‰

Remeber to โญ this repo if you โค this Apps

## ๐ŸŒŽ Local Development

### Prerequisites

Yarn

- ```sh
npm install --global yarn
```

### Development

1. Clone the repo
```sh
git clone https://github.com/zernonia/supabase-schema.git
```
2. Install NPM packages
```sh
yarn install
```
3. Run Development instance
```sh
yarn dev
```

## โž• Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## ๐Ÿ™ Acknowledgement

1. Fundamental for this Visualization ([Generate database types from OpenAPI specification](https://supabase.io/docs/reference/javascript/generating-types#generate-database-types-from-openapi-specification))
2. Guide to Construct Dynamic SVG Connector ([Connecting Table using SVG](https://codepen.io/alojzije/pen/ndfrI))
3. [Icones - icon gallery](https://icones.js.org/)

## ๐Ÿ“ˆ Analytics

I'm using [Umami Analytics](https://umami.is/docs/about) because I'm interested in the distributions of user who uses Supabase and this tool.

[This](https://umami-zernonia.vercel.app/share/yzSUulXQ/Supabase%20Schema) is the public URL for the analytics. Enjoy!

## ๐Ÿ“œ License

Not Associated with Supabase.

Distributed under the MIT License. See `LICENSE` for more information.

# ๐Ÿ“ง Contact

Zernonia - [@zernonia](https://twitter.com/zernonia) - [email protected]

Also, if you like my work, please buy me a coffee โ˜•๐Ÿ˜ณ


Logo