https://github.com/rishiosaur/frens

💖 a web collection for the best people in the world
https://github.com/rishiosaur/frens

Last synced: 5 days ago
JSON representation

💖 a web collection for the best people in the world

• Host: GitHub
• URL: https://github.com/rishiosaur/frens
• Owner: rishiosaur
• License: mpl-2.0
• Created: 2020-10-31T15:54:03.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T15:51:12.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T22:59:00.469Z (over 1 year ago)
• Language: TypeScript
• Homepage: https://w.rishi.cx
• Size: 745 KB
• Stars: 17
• Watchers: 2
• Forks: 10
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 💖 Frens

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

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

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

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

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

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

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.

## Adding yourself

The websites that show up on [the website](https://w.rishi.cx) can be found over at [`routes.json`](https://github.com/rishiosaur/frens/blob/main/routes.json)!

Just add yourself to the array in an object that conforms to the above protocol!

_Note_: You _must_ be on the Hack Club Slack (and be an active member) to be accepted into the collection :p