Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samestrin/url-shortening-api-netlify-edge-supabase
A TypeScript Netlify Edge Function/Supabase based URL shortener REST API. Used by https://frwrd.ing/.
https://github.com/samestrin/url-shortening-api-netlify-edge-supabase
deno netlify netlify-edge netlify-edge-functions netlify-functions netlify-lambda typescript url-shortener url-shortener-microservice
Last synced: about 1 month ago
JSON representation
A TypeScript Netlify Edge Function/Supabase based URL shortener REST API. Used by https://frwrd.ing/.
- Host: GitHub
- URL: https://github.com/samestrin/url-shortening-api-netlify-edge-supabase
- Owner: samestrin
- License: mit
- Created: 2024-05-14T03:17:14.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-18T21:06:55.000Z (8 months ago)
- Last Synced: 2024-05-18T22:21:57.316Z (8 months ago)
- Topics: deno, netlify, netlify-edge, netlify-edge-functions, netlify-functions, netlify-lambda, typescript, url-shortener, url-shortener-microservice
- Language: TypeScript
- Homepage: https://frwrd.ing
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# url-shortening-api-netlify-edge-supabase
[](https://github.com/samestrin/url-shortening-api-netlify-edge-supabase/stargazers)[](https://github.com/samestrin/url-shortening-api-netlify-edge-supabase/network/members)[](https://github.com/samestrin/url-shortening-api-netlify-edge-supabase/watchers)
[](https://opensource.org/licenses/MIT)[](https://nodejs.org/)
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 a high performance, efficient and scalable solution for creating short URLs that redirect to the original, longer URLs.
### Why Netlify Edge Functions?
Netlify Edge Functions are run at the network edge, closer to your users, translating into faster load times. Netlify also offers **1M/month Edge Function executions per month at the free tier**, a significant increase over 125k/month Function executions allocated at the same tier. At the Pro level you have 2m/month to work with.
### Benefits of Edge Functions:
- **Decreased latency**: Running logic closer to the end user can reduce not only the volume of data, but the distance that data needs to travel. If a user were sending a request in Arizona, a response time from a local node would be lower than one in London.
- **Reduction in cold start boot times**: For serverless functions, cold start boot times average anywhere from 50-500ms on average. The cold start average for edge functions, on the other hand, is drastically reduced (50-200ms).
_This replaces the legacy [url-shortening-api-netlify-supabase](https://github.com/samestrin/url-shortening-api-netlify-supabase) project._
### **Features**
- **URL Shortening**: Convert long URLs into short, manageable links that are easier to share.
- **URL Validation**: Ensures that only valid URLs with proper protocols are processed.
- **URL Redirection**: Redirect users to the original long URL based on the short URL.
- **Link Tracking**: Track which short URLs are served.
- **Retrieve Latest Shortened URLs**: Access the most recently created short URLs.
- **URL Count**: Get the total number of URLs shortened.
- **API Versioning**: Retrieve the current version of the API.
- **CORS Support**: Handle cross-origin resource sharing with appropriate headers.
- **Error Handling**: Graceful error handling with appropriate HTTP status codes and error messages.
### **Dependencies**
- **Node.js**: The script runs in a Node.js environment.
- **Deno**: A secure runtime for JavaScript and TypeScript.
- **Supabase (REST API)**: A backend-as-a-service providing a Postgres database, authentication, storage, and more.
- **Netlify Edge Functions**: Serverless functions that run at the edge, closer to your users.
- **multiParser**: Parses multipart form data.
### **Installation**
To set up the project locally, follow these steps:
1. **Clone the Repository**:
```bash
git clone https://github.com/samestrin/url-shortening-api-netlify-edge-supabase.git
cd url-shortening-api-netlify-edge-supabase
```
2. **Install Dependencies**: Ensure you have the required dependencies installed. Use npm or yarn to install any necessary packages.
```bash
npm install
```
3. **Set Up Netlify CLI**: Install the Netlify CLI to deploy and test the functions locally.
```bash
npm install -g netlify-cli
```
4. **Configure Environment Variables**: Create a `.env` file in the project root and define `SUPABASE_URL` and `SUPABASE_ANON_KEY` with your Supabase project credentials. Optionally set `URLSHORT_URL_BASE` to your hostname (example: https://frwrd.ing/), and `URLSHORT_TRACK_CLICKS` to `true` to enable short link click tracking.
5. **Run the Functions Locally**: Use the Netlify CLI to run the edge functions locally.
```bash
netlify dev
```
### **Configuration**
The `netlify.toml` file contains the configuration for the edge functions. Each function is mapped to a specific endpoint:
```toml
[build]
publish = "public"
[build.environment]
NODE_VERSION = "20"
[[edge_functions]]
path = "/shorten"
function = "shorten"
[[edge_functions]]
path = "/count"
function = "count"
[[edge_functions]]
path = "/latest"
function = "latest"
[[edge_functions]]
path = "/version"
function = "version"
[[edge_functions]]
path = "/*"
function = "redirect"
```
## Endpoints
### Shorten URL
**Endpoint:** `/shorten` **Method:** POST
Shorten a long URL and return the shortened URL.
- `url`: The URL to be shortened.
#### **Example Usage**
Use a tool like Postman or curl to make a request:
```bash
curl -X POST \
https://localhost/shorten \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'url=https://www.google.com'
```
The server responds with:
```bash
{"shortUrl":"lqywv6P"}
```
### Forward URL
**Endpoint:** `/[shortId]` **Method:** GET
Based on shortened URL, e.g. `/lqywv6P` HTTP 301 forward to a long url.
This endpoint is accessed by navigating directly to the shortened URL.
#### **Example Usage**
Use curl to make a request:
```bash
curl http://localhost/[shortId]
```
### Retrieve Latest Shortened Links
**Endpoint:** `/latest` **Method:** GET
Retrieve the latest URLs shortened.
This endpoint is accessed by navigating directly to /latest.
#### **Example Usage**
Use curl to make a request:
```bash
curl http://localhost/latest
```
### Retrieve Count
**Endpoint:** `/count` **Method:** GET
Retrieve the number of URLs shortened.
This endpoint is accessed by navigating directly to /count.
#### **Example Usage**
Use curl to make a request:
```bash
curl http://localhost/count
```
### Retrieve Version
**Endpoint:** `/version` **Method:** GET
Retrieve the current version of the API.
This endpoint is accessed by navigating directly to /version.
#### **Example Usage**
Use curl to make a request:
```bash
curl http://localhost/version
```
The server responds with:
```bash
{
"name": "url-shortening-api-netlify-edge-supabase",
"version": "0.0.1",
"description": "url-shortening-api-netlify-edge-supabase is a URL shortener service using Netlify Edge Functions and the Supabase REST API.",
"author": "Sam Estrin",
"homepage": "https://github.com/samestrin/url-shortening-api-netlify-edge-supabase#readme"
}
```
## CORS
The server responds with appropriate CORS headers such as Access-Control-Allow-Origin.
## Error Handling
The API handles errors gracefully and returns appropriate error responses:
- **400 Bad Request**: Invalid request parameters.
- **404 Not Found**: Resource not found.
- **405 Method Not Allowed**: Invalid request method (not GET or POST).
- **500 Internal Server Error**: Unexpected server error.
## Contribute
Contributions to this project are welcome. Please fork the repository and submit a pull request with your changes or improvements.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Share
[](https://twitter.com/intent/tweet?text=Check%20out%20this%20awesome%20project!&url=https://github.com/samestrin/url-shortening-api-netlify-edge-supabase) [](https://www.facebook.com/sharer/sharer.php?u=https://github.com/samestrin/url-shortening-api-netlify-edge-supabase) [](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/samestrin/url-shortening-api-netlify-edge-supabase)