https://github.com/cdvel/url-shortenr
✂️ URL Shortening and redirecting service using Firebase cloud functions
https://github.com/cdvel/url-shortenr
firebase firebase-cloud-functions
Last synced: about 1 month ago
JSON representation
✂️ URL Shortening and redirecting service using Firebase cloud functions
- Host: GitHub
- URL: https://github.com/cdvel/url-shortenr
- Owner: cdvel
- License: apache-2.0
- Created: 2019-09-10T12:15:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T11:54:51.000Z (over 3 years ago)
- Last Synced: 2023-02-27T15:17:12.747Z (over 3 years ago)
- Topics: firebase, firebase-cloud-functions
- Language: TypeScript
- Homepage: https://shortenr.web.app/
- Size: 200 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Store and resolve shortened urls Firebase
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## About The Project
The classic URL shortening/redirecting service using free resources from Firebase (cloud functions, firestore, hosting).
### Built With
* [Firebase](https://firebase.google.com/)
* [Node](https://nodejs.org/)
* [Baseguide](https://basegui.de)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* npm
```sh
npm install npm@latest -g
```
* Firebase CLI
```sh
npm install -g firebase-tools
```
* Login
```sh
firebase login
```
### Installation
1. Clone the repo
```sh
git clone https:://github.com/cdvel/url-shortenr.git
```
2. Install NPM packages
```sh
npm install
```
3. Create and use your firebase project: url-shortener
```sh
firebase projects:create
$ url-shortener
firebase use url-shortener
```
4. Update unique hosting site on firebase.json (ex. https://shortenr.web.app)
```json
"hosting": {
"site": "shortenr",
```
5. Set your authorized google email to access the shortener with
```sh
firebase functions:config:set authorized.email="your-email@gmail.com"
```
6. Deploy
```sh
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](https://github.com/cdvel/url-shortenr/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://twitter.com/cdvel)
[https://github.com/cdvel/url-shortenr](https://github.com/cdvel/url-shortenr)