supaembed

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #llm #android #machine-learning #macos #java #windows #awesome #awesome-list #pytorch #open-source

(★ 24)

Embed custom tools on your website with your Supabase instance.

supaembed Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<br />
<p align="center">
  <a href="https://github.com/zernonia/supaembed">
    <img src="src/assets/logo.png" alt="Logo" width="auto" height="80">
  </a>

<h3 align="center">Supaembed</h3>

<p align="center">
    Embed custom tools on your website with your <strong>Supabase</strong> instance.
    <br />
    Free • Open Source
    <br />
    <br />
    <a href="https://www.aurora.courses/supaembed">View Demo</a>
    ·
    <a href="https://github.com/zernonia/supaembed/issues">Report Bug</a>
    ·
    <a href="https://github.com/zernonia/supaembed/issues">Request Feature</a>
  </p>
</p>

![Supaembed](https://raw.githubusercontent.com/zernonia/supaembed/master/images/og.png)

## 🚀 Features

- 🤩 Free & Open Source
- 🚀 Your own Supabase instance
- 🌟 Your user can interact without signing in (Respect RLS too)
- 🎨 Alowed to use on your own project
- 🌌 No stealing your data, so don't worry 😂

## 📇 About The Project

I wanted to have a **bug/feature request/roadmap tools** in my [latest project, Aurora](https://www.aurora.courses), but I don't want users to sign in another tool just to do that.

Then I discovered the amazing Embedding features by [Dashibase](https://github.com/Dashibase/dashibase-insert), which allow user to embed form and still respect the RLS. I reached out to [SK](https://github.com/greentfrapp) (Thank you! 🙌🏼) to learn the mechanism.

![Supabase Setting's Schema](https://raw.githubusercontent.com/zernonia/supaembed/master/images/settings-schema.png)

After that, I expose the NEW schema (so that it won't clogged up public schema), and utilized Supabase powerful Postgrest endpoint, as well as the embedding feature above to build this tool.

Enjoy! 😁

### 🔨 Built With

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

## Setup (v1)

1. Login to your [Supabase](https://app.supabase.com/) instance that you want to setup this tool.

2. Copy SQL script from [`sql/v1`](/sql/v1), following the file number 1,2,3, and paste it into your Supabase SQL editor and `RUN` it.

> In [1.supabase_function.sql](/sql/v1/1.supabase_function.sql), you will need to add your admin users' uuid to make sure the admin have the capabiltites to handle admin stuff.

3. Go to Dashboard Settings → API → Settings → Schema, and add the newly created **supaembed** schema into the Schema field.
   ![Supabase Setting's Schema](https://raw.githubusercontent.com/zernonia/supaembed/master/images/settings-schema.png)

4. Copy the `script` below and paste in the HTML where you want it to be rendered.
   > It's ok to paste your url and keys here because it's gonna be public anyway 😂

```html
<script src="https://cdn.jsdelivr.net/gh/zernonia/supaembed@1.0.0/dist/embed.js" async defer></script>
<div id="supaembed" data-url="YOUR SUPABASE URL" data-anon-key="YOUR SUPABASE ANON KEY"></div>
```

5. That's it! You should be able to see Supaembed on your website now!

> Let me know if anything stuck!

## 🌎 Local Development

### Prerequisites

Yarn

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

### Development

1. Clone the repo
   ```sh
   git clone https://github.com/zernonia/supaembed.git
   ```
2. Install NPM packages
   ```sh
   cd supaembed
   yarn install
   ```
3. Run local Vercel 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

- Thank you [SK](https://github.com/greentfrapp) for discovering the possibilities of embedding tools that respect User's RLS and share it with me! Check out [Dashibase](https://dashibase.com/)!

- Thank you [Austin Malerba](https://github.com/malerba118) for [Supabase Comment Extension](https://github.com/malerba118/supabase-comments-extension) that scaffold the comment for this project. Check out [Scrollex](https://scrollex-docs.vercel.app/)

## 📜 License

Not Associated with Supabase.

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

# 📧 Contact

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

Also, if you like my work, please buy me a coffee ☕😳

supaembed

supaembed Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

supaembed

supaembed Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README