Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/andrewjbateman/next-tailwind-supabase

:clipboard: Next.js PWA to display data from a Supabase PostgreSQL database
https://github.com/andrewjbateman/next-tailwind-supabase

nextjs pwa react react17 supabase tailwind-css

Last synced: about 1 month ago
JSON representation

:clipboard: Next.js PWA to display data from a Supabase PostgreSQL database

Host: GitHub
URL: https://github.com/andrewjbateman/next-tailwind-supabase
Owner: AndrewJBateman
Created: 2022-04-22T16:04:15.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-04-23T15:55:13.000Z (almost 3 years ago)
Last Synced: 2024-11-07T03:33:21.171Z (3 months ago)
Topics: nextjs, pwa, react, react17, supabase, tailwind-css
Language: TypeScript
Homepage: http://next-tailwind-supabase-nu.vercel.app
Size: 3.77 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # :zap: Next Tailwind Supabase

* Next.js PWA to display data from a Supabase PostgreSQL database

* **Note:** to open web links in a new window use: _ctrl+click on link_

![GitHub repo size](https://img.shields.io/github/repo-size/AndrewJBateman/next-tailwind-supabase?style=plastic)

![GitHub pull requests](https://img.shields.io/github/issues-pr/AndrewJBateman/next-tailwind-supabase?style=plastic)

![GitHub Repo stars](https://img.shields.io/github/stars/AndrewJBateman/next-tailwind-supabase?style=plastic)

![GitHub last commit](https://img.shields.io/github/last-commit/AndrewJBateman/next-tailwind-supabase?style=plastic)

## :page_facing_up: Table of contents

* [:zap: Next Tailwind Supabase](#zap-next-tailwind-supabase)

  * [:page_facing_up: Table of contents](#page_facing_up-table-of-contents)

  * [:books: General info](#books-general-info)

  * [:camera: Screenshots](#camera-screenshots)

  * [:signal_strength: Technologies](#signal_strength-technologies)

  * [:floppy_disk: Setup](#floppy_disk-setup)

  * [:flashlight: Testing](#flashlight-testing)

  * [:computer: Code](#computer-code)

  * [:cool: Features](#cool-features)

  * [:clipboard: Status & To-Do List](#clipboard-status--to-do-list)

  * [:clap: Inspiration](#clap-inspiration)

  * [:file_folder: License](#file_folder-license)

  * [:envelope: Contact](#envelope-contact)

## :books: General info

* Supabase is an open-source alternative to Firebase, but uses PostgreSQL instead of document database. Database is realtime & can use SQL joins. Realtime notifications via Websockets. RESTful API requires no backend code.

* Next.js uses React v17

* [Progressive Web App](https://en.wikipedia.org/wiki/Progressive_web_application) with a service worker for programmable content caching and a web manifest so app can be found by search engines.

## :camera: Screenshots

![Example screenshot](./img/lighthouse.png)

## :signal_strength: Technologies

* [Next.js v12](https://nextjs.org/) React framework

* [React v17](https://reactjs.org/) Javascript library

* [Supabase public Beta](https://supabase.io/) Postgres database

* [supabase-js v1](https://www.npmjs.com/package/@supabase/supabase-js) isomorphic Javascript client for Supabase

* [TailwindCSS v3](https://www.npmjs.com/package/tailwindcss) CSS framework that helps create very light build packages

* [@tailwindcss/aspect-ratio](https://www.npmjs.com/package/@tailwindcss/aspect-ratio) used to give elements different fixed aspect ratios depending on screen width

* [next-secure-headers v2](https://www.npmjs.com/package/next-secure-headers) to set secure response headers

## :floppy_disk: Setup

* `npm i` to install dependencies then...

* Create free account with Supabase and create table

* Add data to table - I found image URLs from [Pinterest](https://www.pinterest.com.mx/). Data was exported from Supabase as a CSV file - see `images_allRows.csv`. It is easy to import this into a new Supabase table and set id as the Primary Key. Database also requires a Function Hook to be added so database changes are shown in the deployed app

* Create `.env.local` then add your Supabase API Authentication credentials as shown in `.env.example.local`

* `npm run dev` for a dev server. Navigate to `http://localhost:3000/` - app will automatically reload if you change any of the source files

* `npm run build` for a build folder - not necessary as Vercel creates build files during Deployment

## :flashlight: Testing

* Tests not set up

## :computer: Code

* `index.tsx` function to get data from Supabase database

```typescript

export async function getStaticProps() {

  const supabaseAccess = createClient(

    process.env.SUPABASE_URL || '',

    process.env.SUPABASE_KEY || ''

  )

  const { data } = await supabaseAccess.from('images').select('*').order('id')

  return {

    props: {

      images: data,

    },

  }

}

```

## :cool: Features

* Supabase user interface is cool to work with and they have SQL templates to create a user login etc.

* Changes to the Supabase data are automatically displayed in the deployed app using a Supabase Function Hook

* 100% perfect Lighthouse score

## :clipboard: Status & To-Do List

* Status: Working PWA, deployed to Vercel. 100% Lighthouse score

* To-Do: Nothing

## :clap: Inspiration

* [Youtube: Lee Robinson: Building an Image Gallery with Next.js, Supabase, and Tailwind CSS](https://www.youtube.com/watch?v=BSoRXk1FIw8) but with my own database data, other modifications for a perfect Lighthouse score, including conversion to PWA.

## :file_folder: License

* N/A

## :envelope: Contact

* Repo created by [ABateman](https://github.com/AndrewJBateman), email: [email protected]