Git Product home page Git Product logo

supaembed's Introduction


Logo

Supaembed

Embed custom tools on your website with your Supabase instance.
Free • Open Source

View Demo · Report Bug · Request Feature

Supaembed

🚀 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, but I don't want users to sign in another tool just to do that.

Then I discovered the amazing Embedding features by Dashibase, which allow user to embed form and still respect the RLS. I reached out to SK (Thank you! 🙌🏼) to learn the mechanism.

Supabase Setting's Schema

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

Setup (v1)

  1. Login to your Supabase instance that you want to setup this tool.

  2. Copy SQL script from 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, 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

  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 😂

<script src="https://cdn.jsdelivr.net/gh/zernonia/[email protected]/dist/embed.js" async defer></script>
<div id="supaembed" data-url="YOUR SUPABASE URL" data-anon-key="YOUR SUPABASE ANON KEY"></div>
  1. That's it! You should be able to see Supaembed on your website now!

Let me know if anything stuck!

🌎 Local Development

Prerequisites

Yarn

  • npm install --global yarn

Development

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

📜 License

Not Associated with Supabase.

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

📧 Contact

Zernonia - @zernonia - [email protected]

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

Logo

supaembed's People

Contributors

harryet avatar zernonia avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.