Merge pull request #1 from samestrin/development

Development

Author: samestrin

README.md

@@ -1 +1,5 @@
-# url-shortening-api-netlify-edge-supabase
+# url-shortening-api-netlify-edge-supabase
+
+url-shortening-api-netlify-edge-supabase is a URL shortener service. It is a serverless application that provides URL shortening and retrieval functionalities. Utilizing Netlify Edge Functions and Supabase, a cloud-based database, the application offers an efficient and scalable solution for creating short URLs that redirect to the original, longer URLs.
+
+This replaces the legacy [url-shortening-api-netlify-supabase](https://github.com/samestrin/url-shortening-api-netlify-supabase) project.

netlify.toml

@@ -16,6 +16,10 @@
   path = "/latest"
   function = "latest"
 
+[[edge_functions]]
+  path = "/version"
+  function = "version"
+
 [[edge_functions]]
   path = "/*"
   function = "redirect"

netlify/edge-functions/version.ts

@@ -0,0 +1,33 @@
+import packageJson from "../../package.json" assert { type: "json" };
+
+export default async (request: Request): Promise<Response> => {
+  try {
+    const { name, description, author, homepage, version } = packageJson;
+
+    const response = {
+      name,
+      version,
+      description,
+      author,
+      homepage,
+    };
+
+    return new Response(JSON.stringify(response), {
+      status: 200,
+      headers: {
+        "Content-Type": "application/json",
+      },
+    });
+  } catch (error) {
+    console.error("Error reading package.json:", error);
+    return new Response(
+      JSON.stringify({
+        error: "Internal server error",
+        details: error.message,
+      }),
+      { status: 500 }
+    );
+  }
+};
+
+export const config = { path: "/version" };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "url-shortening-api-netlify-edge-supabase",
   "version": "0.0.1",
-  "description": "",
+  "description": "url-shortening-api-netlify-edge-supabase is a URL shortener service using Netlify Edge Functions and the Supabase REST API.",
   "main": "public/index.html",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

supabase.md

@@ -0,0 +1,33 @@
+# url-shortening-api-netlify-edge-supabase
+
+## Supabase Setup
+
+Setting up Supabase for your project involves a few key steps, from creating an account to initializing your database and integrating it with your application. Here’s a detailed walkthrough:
+
+**Sign Up and Create a New Project**:
+
+Visit [Supabase](https://supabase.io/) and sign up for a new account if you don't already have one.
+
+Once logged in, create a new project by specifying a project name, database password, and the region closest to your users to minimize latency.
+
+**Project Setup**:
+
+After your project is created, which might take a few minutes, you will be redirected to the project dashboard.
+
+Your project’s URL (`SUPABASE_URL`) and anon key (`SUPABASE_ANON_KEY`), which are required for connecting your application to Supabase, can be found under the `Settings` -> `API` section of your Supabase project dashboard.
+
+## Database Configuration
+
+Create Tables: Use the SQL editor in Supabase to create the necessary tables for your application. For the URL shortener, you’ll need a table to store URLs with columns for the short URL and the original URL.
+
+```sql
+CREATE TABLE urls (
+  id SERIAL PRIMARY KEY,
+  short_url VARCHAR(255) UNIQUE NOT NULL,
+  long_url VARCHAR(2048) NOT NULL
+);
+```
+
+**Row Level Security (RLS)**:
+
+Enable RLS for your tables to ensure that your data is secure and accessible only according to your specified policies.