https://github.com/developeranaz/serverless-url-shortner
Serverless URL shortener based on raw text link via cloudflare workers
https://github.com/developeranaz/serverless-url-shortner
Last synced: 12 months ago
JSON representation
Serverless URL shortener based on raw text link via cloudflare workers
- Host: GitHub
- URL: https://github.com/developeranaz/serverless-url-shortner
- Owner: developeranaz
- License: apache-2.0
- Created: 2023-01-24T15:33:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-15T17:15:27.000Z (almost 3 years ago)
- Last Synced: 2025-01-12T17:12:50.028Z (about 1 year ago)
- Language: HTML
- Size: 42 KB
- Stars: 15
- Watchers: 3
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless-URL-Shortner
Serverless URL shortener based on raw text link via cloudflare workers
# URL Redirector
This JavaScript script uses the Fetch API and the `addEventListener` function to handle a request event and redirect the user to a specific URL based on a unique ID passed in the request URL.
# How to deploy to Cloudflare and create an account
## Creating a Cloudflare account
1. Go to the Cloudflare website at https://www.cloudflare.com/.
2. Click on the "Sign Up" button in the top right corner of the page.
3. Follow the prompts to create your account.
## Deploying to Cloudflare
1. Login to your Cloudflare account.
2. Go to the "Workers" section of the Cloudflare dashboard.
3. Click on the "Create a Worker" button.
4. In the "Script" section, copy the contents of your `worker.js` file.
5. Replace the 12th line of the `worker.js` file with the URL of your hosted application. For example:
```
const urlList = await fetch('https://raw.githubusercontent.com/developeranaz/Serverless-URL-Shortner/main/urls.txt')
```
6. Click on the "Save and Deploy" button.
7. Test your worker by sending a request to your Cloudflare worker URL.
Congratulations! Your application is now deployed to Cloudflare.
## How it works
1. The script listens for a `fetch` event using the `addEventListener` function and calls the `handleRequest` function when the event is triggered. The request object is passed to the `handleRequest` function as an argument.
2. The `handleRequest` function extracts the unique ID from the request URL by creating a new `URL` object and using the `searchParams.get()` method.
3. Next, the function fetches a raw text file containing a list of URLs and splits the text into an array of strings, one for each line.
4. The function then uses the `Array.prototype.find()` method to find the URL associated with the unique ID from the above array.
5. If the ID is not found, the function returns a new Response object with a status code of 404 and a message "Invalid ID"
6. If the ID is found, the function redirects the user to the associated URL by returning a new Response object with a status code of 301 and a `Location` header set to the URL associated with the ID.
## Example
For example, if the raw text file contains the following URLs:
```
abc123 https://example1.com
def456 https://example2.com
ghi789 https://example3.com
```
and a request is made to `https://example.com?id=abc123`, the script will redirect the user to `https://example1.com`.
## TODO and Limitations
I have not yet created an encrypted admin page for the URL shortener to add or remove shortened links. I will make it later. For now, please edit your raw text URL in your hosted location. I have used a raw Gist GitHub link, which can be edited later using our GitHub account. I am not aware of any security issues or disadvantages for this project, as using Gist GitHub or personal GitHub may have some rate limits. You can customize this to meet your own needs. I made this project for personal use.