README.md

✂️ URL Shortenr

Store and resolve shortened urls Firebase


View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

The classic URL shortening/redirecting service using free resources from Firebase (cloud functions, firestore, hosting).

Built With

• Firebase
• Node
• Baseguide

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

npm install npm@latest -g

• Firebase CLI

npm install -g firebase-tools

• Login

firebase login

Installation

1. Clone the repo

git clone https:://github.com/cdvel/url-shortenr.git

2. Install NPM packages

npm install

3. Create and use your firebase project: url-shortener

firebase projects:create
$ url-shortener

firebase use url-shortener

4. Update unique hosting site on firebase.json (ex. https://shortenr.web.app)

  "hosting": {
    "site": "shortenr",

5. Set your authorized google email to access the shortener with

firebase functions:config:set authorized.email="[email protected]"

6. Deploy

firebase deploy

Usage

1. Copy and paste a long URL and click "Shorten ✂️"
2. A shortened URL such as https://shortenr.web.app/SH0RT is generated
3. A list of all shortened URLS can be found at https://console.firebase.google.com/u/0/project/`{your-project}`/storage

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the Apache License. See LICENSE for more information.

Contact

https://twitter.com/cdvel

https://github.com/cdvel/url-shortenr