https://github.com/microsoft/azurlshortener

An simple and easy Url Shortener
https://github.com/microsoft/azurlshortener

azure azure-container-apps blazor container csharp fluentui-blazor serverless storage url-shortener

Last synced: 18 days ago
JSON representation

An simple and easy Url Shortener

Host: GitHub
URL: https://github.com/microsoft/azurlshortener
Owner: microsoft
License: mit
Created: 2020-03-10T11:04:16.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2025-03-28T20:41:46.000Z (about 1 month ago)
Last Synced: 2025-04-06T13:02:55.749Z (26 days ago)
Topics: azure, azure-container-apps, blazor, container, csharp, fluentui-blazor, serverless, storage, url-shortener
Language: C#
Homepage:
Size: 23.8 MB
Stars: 541
Watchers: 29
Forks: 607
Open Issues: 26
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Azure Url Shortener (AzUrlShortener)

![GitHub Release](https://img.shields.io/github/v/release/microsoft/AzUrlShortener)  ![.NET](https://img.shields.io/badge/9.0-512BD4?logo=dotnet&logoColor=fff) [![Build](https://github.com/microsoft/AzUrlShortener/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/microsoft/AzUrlShortener/actions/workflows/build.yml) ![GitHub License](https://img.shields.io/github/license/microsoft/AzUrlShortener)

[![All Contributors](https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat-square)](#contributors-)

![UrlShortener][UrlShortener]

A simple and easy to use and to deploy budget-friendly Url Shortener for everyone. It runs in your Azure (Microsoft cloud) subscription.  

> If you don't own an Azure subscription already, you can create your **free** account today. It comes with 200$ credit, so you can experience almost everything without spending a dime. [Create your free Azure account today](https://azure.microsoft.com/free?WT.mc_id=dotnet-0000-frbouche)

Features:

- Redirect different destination base on schedules.

- Keep Statistics of your clicks.

- Budget-friendly and 100% open-source.

- Extensible for more enterprise-friendly configurations

- Simple step by step deployment. 

  

## How To Deploy

👉 **[Step by Step Deployment](doc/how-to-deploy.md)** 👈 documentation is available here.

If you want to **Update** or **Upgrade**, please refer to [the faq page](doc/faq.md). 

## How To Use It

Once deployed, use the admin webApp (aka TinyBlazorAdmin) to create new short URLs. 

![Tiny Blazor Admin looks](images/tinyblazyadmin-tour.gif)

### Alternative Admin Tool

By default, all the required resources are deployed into Azure. However you can decide to run the [API](src/Cloud5mins.ShortenerTools.Api/) locally, in a container or somewhere else. You can than use an API client like [Postman](https://www.postman.com/) or a plugin to VSCode like [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client), to manage your URLs. We've included simple API calls via a postman collection and environment [here](./src/tools/).

You can also directly update the tables in storage using [Azure Storage Explorer](doc/how-to-use-azure-storage-explorer.md). 

---

## Videos

There is also a videos that explains a bit how things works and does a quick tour of the project.

| Cloud 5 Mins | Azure Friday |

| ---          | --- |

| [![Tiny Blazor Admin looks](images/AzUrlShortener_preview.gif)](https://youtu.be/fzXy2D77WMM) | [![Azure Friday](/images/AzureFriday_preview.gif)](https://learn.microsoft.com/en-us/shows/azure-friday/azurlshortener-an-open-source-budget-friendly-url-shortener)  |

---

## What's Next?

We are always trying to make it better. See the [AzUrlShortener project](https://github.com/users/FBoucher/projects/6/views/4) page and [issues](https://github.com/microsoft/AzUrlShortener/issues) to see the current progress. 

You are invited to go into the [Discussion](https://github.com/microsoft/AzUrlShortener/discussions) tab to share your feedback, ask question, and suggest new feature! Or have look at our [faq](doc/faq.md) page for more information.

Current Backlog contains:

- More Statistics

- QR Code

- More tracking information (like Country)

- etc.

---

## Contributing

If you find a bug or would like to add a feature, check out those resources:

Check out our [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) docs. This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.  Contributions of any kind welcome!

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
_SurlyDev
🤔

      
_{Frank Boucher}
💻 📹 🐛

      
_AKER
🤔

      
_{Vincent Baaij}
💻

      
_kmm7
💻 🤔

      
_fs366e2spm
🐛 🤔

      
_{Hugo Hedlund}
💻

    

    

      
_{Nathan Fisk}
📖

      
_{Erik Alsmyr}
🐛 📖

      
_{Bernard Vander Beken}
📖

      
_IronManion
📖

      
_{Jason Hand}
📖 🚇

      
_{Scott Cate}
💻

      
_arglgruml
🐛

    

    

      
_{DavidTCarpenters}
💻

      
_{Roger D. Winans}
📖

      
_fatpacket
📖

      
_{Chad Voelker}
💻 📖

      
_{David Ginn}
💻

      
_{Catcher Wong}
💻

      
_{Zhiqiang Li}
💻

    

    

      
_ddematheu2
🐛 💻

      
_{David Oliva Paredes}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

> This project was inspired by a project created by [Jeremy Likness](https://github.com/JeremyLikness) that you can find here [jlik.me](https://github.com/JeremyLikness/jlik.me).

[UrlShortener]: images/UrlShortener_600.png

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/microsoft/azurlshortener

Awesome Lists containing this project

README