Skip to content

Latest commit

聽

History

History
106 lines (68 loc) 路 3.44 KB

README.md

File metadata and controls

106 lines (68 loc) 路 3.44 KB
Raw

Supafactor: Does your README have it?

A Rick-and-Morty-Xfactor-inspired experience

Supafactor: Pass聽聽Netlify Status

PLAY: Try Supafactor for yourself

WATCH: Watch a demo

Supafactor: Does your README have it?

Hi there, I鈥檓 Dan Ryland (@RealDanRyland). Perhaps you recall my previous hackathon endeavour, Groove AI? Well, buckle up because I'm back for round two!

If you're anything like me - a creative soul who's endlessly entertained by the ingenious world of Rick and Morty - you'll appreciate the depths of imagination that show dives into. It's the fantastic characters, intriguing worlds, and gripping storylines that always leave me awestruck.

Taking a page from Rick and Morty's vibrant visual style and combining it with the thrill of talent shows, I introduce to you: Supafactor - a groundbreaking way to judge hackathon entries.

Through four criteria: creativity, functionality, Supabase-ness and fun, our Supafactor judge will give realtime feedback on the README of your hackathon entry.

Based on Simon鈥檚 feedback - yes, we have our very own, Rick-and-Morty-inspired, Simon Cowell - you鈥檒l then find out if you get to claim the coveted status of having the Supafactor.

Does your README have the Supafactor? Let鈥檚 find out

How does it work?

Simply log in via Github, and Supafactor will display eligible repositories created during Hackathon 8. Choose one, and watch as your README is scrutinised against our criteria using Open AI's GPT 3.5 Turbo. Anticipate feedback with a blend of cheeky wit and sass. Concluding with a score, see if your README boasts the Supafactor charm. And yes, bragging rights come with badges for those who make the cut!

Ready to test your README? Let's discover if you've got the Supafactor

Supabase features

The following Supabase features are being used:

  • Auth
    • Through OAuth (Github)
  • Database
    • Fetch
    • Upsert
  • Storage
    • Public images
  • Edge function
    • Open AI (GPT 3.5 Turbo)

Design process

  • Figma for prototyping and designing assets
  • Midjourney for Rick-and-Morty inspired backgrounds and assets
  • Vectorizer for converting Midjourney assets to SVGs

Build process

Built entierly using Quasar framework

To run locally, you'll need the following:

Environment variables

SITE_URL
SUPABASE_URL
SUPABASE_KEY
SUPABASE_FUNCTION

For the edge function:

OPEN_API_KEY

Install the dependencies

yarn
# or
npm install

Start the app in development mode (hot-code reloading, error reporting, etc.)

quasar dev

Deploy

Deploy the Supabase edge function:

supabase functions deploy review

Hosted on Netlify

Build the app for production

quasar build

Publish directory:

dist/spa