Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/azurlshortener
An simple and easy Url Shortener
https://github.com/microsoft/azurlshortener
azure hacktoberfest serverless storage url-shortener
Last synced: 5 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 (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-20T21:02:04.000Z (10 days ago)
- Last Synced: 2025-01-25T18:05:01.182Z (5 days ago)
- Topics: azure, hacktoberfest, serverless, storage, url-shortener
- Language: C#
- Homepage:
- Size: 21.5 MB
- Stars: 528
- Watchers: 29
- Forks: 585
- Open Issues: 45
-
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)
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FAzUrlShortener%2Fmain%2Fsrc%2Fdeployment%2FazureDeploy.json)
[](https://serverlesslibrary.net/sample/1c809aa2-2d4f-4fee-bc27-0c2c36844ac8)
[](#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](https://github.com/microsoft/AzUrlShortener/wiki/How-to-deploy-your-AzUrlShortener)** (wiki pages) 👈 documentation is available here. If you would like to used the TinyBlazorAdmin as frontend (suggested) **you must first** follow the [steps to follow for TinyBlazorAdmin](https://github.com/microsoft/AzUrlShortener/wiki/How-to-deploy-TinyBlazorAdmin).
If you want to **Update** or **Upgrade**, please refer to [this page](https://github.com/microsoft/AzUrlShortener/wiki/How-to-Update---Upgrade) (wiki pages).
## How To Use It
AzUrlShortener is an API that doesn't have any admin UI by default. There are many different ways to manage your Short Urls, from a direct HTTP call to a fancy website.
We suggest [Tiny Blazor Admin](./src/Cloud5mins.ShortenerTools.TinyBlazorAdmin/README.md); it's a static website.
By default, without any specific Admin tool, you can 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). 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](https://github.com/microsoft/AzUrlShortener/wiki/How-to-Use-Azure-Storage-Explorer-as-Admin-Tools-for-AzUrlShortener).
---
## How It Works
If you are interested to learn more about what's under the hood, and get more details on each Azure Function, read the [How it works](https://github.com/microsoft/AzUrlShortener/wiki/how-it-works) page.
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 |
| --- | --- |
| [](https://youtu.be/fzXy2D77WMM) | [](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!
Current Backlog contains:
- A deployment option with everything combined into TinyBlazorAdmin
- 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]: https://github.com/microsoft/AzUrlShortener/raw/main/Media/UrlShortener_600.png
[ThumbnailYTAzUrlShortener_EN]: https://github.com/microsoft/AzUrlShortener/raw/main/Media/ThumbnailYTAzUrlShortener_EN.png
[glo]: https://github.com/microsoft/AzUrlShortener/raw/main/Media/glo-board_screenshot.png
[AzFunctionGitSync]: https://github.com/microsoft/AzUrlShortener/raw/main/Media/AzFunctionGitSync.png