Most technically impressive Supabase Hackathon 2024

Introduction

A CLI tool to automate manual effort/repetitive things when using Supabase.

Architecture

This project uses C4 Model to describe the architecture of the system.

Container Diagram

Component Diagram

Key Objectives

• Automate manual effort/repetitive things
• Make your life easier when using supabase

Features

• Init supabase client project using selected template
• Generate and update models and CRUD functionality based on supabase tables
• Ability to detect changes and print diff (Soon)
• Ability to install module into existing project (ex: auth, realtime, etc) (Soon)

Getting Started

Pre-requisites

• Dart (version 3.5.2 or higher)
• Supabase acccount and project setup

Installation

Linux & MacOS

curl -fsSL https://raw.githubusercontent.com/supagen/supagen/refs/heads/main/scripts/install.sh | bash

Windows

1. Open PowerShell as an administrator.
2. Go to the folder you want to install the script.
3. Download the installation script:

Invoke-WebRequest -Uri "https://raw.githubusercontent.com/supagen/supagen/refs/heads/main/scripts/install.ps1" -OutFile "install.ps1"

4. Run the Script

.\install.ps1

Usage

Usage: supagen <command> [arguments]

Global options:
-h, --help    Print this usage information.
--verbose     Print verbose output.

Available commands:
  init      Initialize a new Supabase project
  update    Update Supabase table definitions
  generate  Generate code for your project
  version   Print the current version of supagen

Run "supagen help <command>" for more information about a command.

Contributors

License

This project is licensed under the MIT License - see the LICENSE file for details.