Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/travisvn/supabase-pause-prevention
Prevent Supabase projects from getting paused due to inactivity
https://github.com/travisvn/supabase-pause-prevention
automation collaborate database free github javascript next nextjs react reactjs sql startup startups student-vscode supabase template templates typescript vercel
Last synced: 3 days ago
JSON representation
Prevent Supabase projects from getting paused due to inactivity
- Host: GitHub
- URL: https://github.com/travisvn/supabase-pause-prevention
- Owner: travisvn
- License: mit
- Created: 2024-05-02T02:09:03.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T23:51:15.000Z (2 months ago)
- Last Synced: 2024-09-16T00:48:33.346Z (2 months ago)
- Topics: automation, collaborate, database, free, github, javascript, next, nextjs, react, reactjs, sql, startup, startups, student-vscode, supabase, template, templates, typescript, vercel
- Language: TypeScript
- Homepage:
- Size: 102 KB
- Stars: 19
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Supabase Pause Prevention ⏸️
[](https://img.shields.io/github/sponsors/travisvn)
🛑 Stop Supabase projects from pausing due to inactivity! :raised_hands:
> On the free-tier plan, projects that are inactive for more than 7 days are paused.
# Please star ⭐️ if you find this useful
> [!TIP]
> __NEW & IMPROVED VERSION__ written in Python available at [supabase-inactive-fix repo](https://github.com/travisvn/supabase-inactive-fix)
## Solution / How it works
- Creating a _cron job_ (scheduled task) that makes a simple database call
- _(This keeps your Supabase project active)_
- Fetching `keep-alive.ts` API endpoints for the other projects, as Vercel limits free-tier users to one cron job.
## Getting Started
**Super simple to add to your existing Supabase project!**
### Configure your main project
_Only 3 files matter_
- [`/app/api/keep-alive/route.ts`](app/api/keep-alive/route.ts) - API endpoint the cron job will execute
- [`/app/api/keep-alive/helper.ts`](app/api/keep-alive/helper.ts) - Helper functions called from `route.ts`
- [`/config/keep-alive-config.ts`](config/keep-alive-config.ts) - Configuration for your setup
- [`/vercel.json`](vercel.json) - Directs Vercel to periodically run the `keep-alive` endpoint
`utils/supabase` folder contains files provided in the Supabase docs for the [Next.js Web App demo — Supabase](https://supabase.com/docs/guides/getting-started/tutorials/with-nextjs)
Everything else is boilerplate from Next.js `create-next-app`
### Configuring your other Supabase projects
After selecting your primary project _(the one that implements the code provided in this repository)_, you'll want to add an API endpoint to your other Supabase projects
The only requirement is that this endpoint is reachable and makes a call to your Supabase database
> [!NOTE]
> API endpoint must make database call
> Ensure the server doesn't cache this
Example of a setup using Prisma as an ORM
`/pages/api/keep-alive.ts`
```typescript
// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
import type { NextApiRequest, NextApiResponse } from 'next'
import { prisma } from 'src/server/db'
// See next example for contents of @/utils/helper
import { generateRandomString } from '@/utils/helper'
export default async function handler(
_req: NextApiRequest,
res: NextApiResponse
) {
try {
const randomString = generateRandomString()
const dbResponse = await prisma.keepAlive.findMany({
where: {
name: {
equals: randomString,
}
}
})
const successMessage = (dbResponse != null) ? `Success - found ${dbResponse.length} entries` : "Fail"
res.status(200).json(successMessage)
} catch (e) {
res.status(401).send("There was an error")
}
}
```
`/prisma/schema.prisma`
```prisma
// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema
generator client {
provider = "prisma-client-js"
previewFeatures = ["postgresqlExtensions"]
}
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
extensions = [uuidOssp(map: "uuid-ossp")]
}
model KeepAlive {
id BigInt @id @default(autoincrement())
name String? @default("")
random String? @default(dbgenerated("gen_random_uuid()")) @db.Uuid
}
```
Helper function for '/pages' directory (legacy support)
`/utils/helper.ts`
```typescript
const defaultRandomStringLength: number = 12
const alphabetOffset: number = 'a'.charCodeAt(0)
export const generateRandomString = (length: number = defaultRandomStringLength) => {
let newString = ''
for (let i = 0; i < length; i++) {
newString += String.fromCharCode(alphabetOffset + Math.floor(Math.random() * 26))
}
return newString
}
```
### Sample SQL
Any table and column can be called, but if you'd rather go with a generic, here's a SQL query for a `keep-alive` table
```sql
CREATE TABLE "keep-alive" (
id BIGINT generated BY DEFAULT AS IDENTITY,
name text NULL DEFAULT '':: text,
random uuid NULL DEFAULT gen_random_uuid (),
CONSTRAINT "keep-alive_pkey" PRIMARY key (id)
);
INSERT INTO
"keep-alive"(name)
VALUES
('placeholder'),
('example');
```
> [!IMPORTANT]
> It is now **strongly recommended** to use a `keep-alive` table like the one above.
> This is in light of the added features for _optional_ database insertion & deletion actions
___
### Sample response
Visiting `https://your-project-domain.vercel.app/api/keep-alive`
```
Results for retrieving
'mzmgylpviofc' from 'keep-alive' at column 'name': []
Other Endpoint Results:
https://your-other-vercel-project-urls.vercel.app/api/keep-alive - Passed
https://your-other-supabase-app.com/api/keep-alive - Passed
```
Extended response (with insertion / deletion)
```
Results for retrieving entries from 'keep-alive' - 'name column: [{"name":"placeholder"},{"name":"random"}, ... ,{"name":"uujyzdnsbrgi"}]
Results for deleting
'uujyzdnsbrgi' from 'keep-alive' at column 'name': success
```
___
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).