vitqst / shrtn-deno

A simple link shortener using Airtable, Vercel, and Deno 🦕

---

• Node.js version
• Examples
• Prerequisites
• Usage
  • One-click deploy
  • Fork and push to repository
• Configuration
  • Default redirect
• Bug or feature request
• License

---

Node.js version

This is the Deno version of Shrtn. View the original Node.js version on https://github.com/grikomsn/shrtn.

Examples

• Google: https://shrtn-deno.now.sh/google
• Google (no cache): https://shrtn-deno.now.sh/google?nocache
• Google (disabled): https://shrtn-deno.now.sh/google-disabled
• Google (generated uid): https://shrtn-deno.now.sh/ecKS6s70c363wHYh

View source links at the Shrtn Airtable base template.

Prerequisites

• Mandatory (for deployment purposes)

  • Airtable account and API key
  • Shrtn Airtable base template
  • Vercel account + GitHub integration

• Optional (for development purposes)

  • Deno

Usage

One-click deploy

1. Copy the Shrtn Airtable base template to your workspace

2. Generate your Airtable API key

3. Click 'deploy to now' button above and enter your API key and base ID to the environment variables prompted

4. Add your links to your copied Airtable base and enjoy

Fork and push to repository

1. Copy the Shrtn Airtable base template to your workspace

2. Generate your Airtable API key

3. Fork this repository

4. Add your API key to vercel secrets

   $ vercel secrets add airtable-api-key keyXXXXXXXXXXXXXX

   Note: vercel is a CLI program which you can install by running npm -g i vercel or yarn global add vercel

5. Add your base ID on vercel.json

   {
     "env": {
       "AIRTABLE_API_KEY": "@airtable-api-key",
       "AIRTABLE_BASE_ID": "appXXXXXXXXXXXXXX"
     }
   }

6. Push repository and Vercel will automagically deploy your instance

7. Add your links to your Airtable base and enjoy

Configuration

Default redirect

If base URL is accessed or no unique URL is given, the function will redirect to a specific URL defined on the vercel.json configuration file.

You can configure the default redirect by changing the redirects[0].destination value on the vercel.json file.

Bug or feature request

Submit an issue if there's a bug or if you have any ideas on how to improve this project.

License

MIT License Copyright (c) 2020 Griko Nibras