https://github.com/sampoder/innov-week-urls

https://github.com/sampoder/innov-week-urls

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sampoder/innov-week-urls
• Owner: sampoder
• License: mpl-2.0
• Created: 2020-12-19T03:25:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-26T07:52:19.000Z (almost 5 years ago)
• Last Synced: 2025-02-08T04:44:37.454Z (12 months ago)
• Language: TypeScript
• Homepage: innov-week-link-shortener.sampoder.vercel.app
• Size: 163 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# LL

![lint status](https://github.com/rishiosaur/ll/workflows/lint/badge.svg)

![format status](https://github.com/rishiosaur/ll/workflows/format/badge.svg)

![GitHub](https://img.shields.io/github/license/rishiosaur/ll)

![GitHub issues](https://img.shields.io/github/issues/rishiosaur/ll)

![GitHub contributors](https://img.shields.io/github/contributors/rishiosaur/ll)

![GitHub last commit](https://img.shields.io/github/last-commit/rishiosaur/ll)

A minimal link shortener powered by Next.js and Vercel.

## Structure of a route:

```

{

  url: string

  name: string

  public: boolean

  title?: string

  description?: string

}

```

`url` is the end URL that you'd like to redirect to.

`name` is the name of the route that redirects to `url`.

`public` is a boolean that determines whether or not this redirect shows up in the public directory.

## Basic Setup

`LL` was created to be completely open; it works with any data source that returns an array of objects that conform to the above protocol.

For the most basic setup, you can generate a basic data source by using the [ll-basic](https://github.com/rishiosaur/ll-basic) template. Hit the `routes.json` file and click "Raw" (the returned JSON implements the above protocol; try parsing it yourself!)

The returned URL will be your API url. Just click the button below, and fill in the appropriate fields.

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Frishiosaur%2Fll&env=apiURL&project-name=link-shortener&repo-name=link-shortener)