Azure Url Shortener (AzUrlShortener)
A simple and easy to use and to deploy budget-friendly Url Shortener for everyone. It runs in Azure (Microsoft cloud) in your 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
Features:
- 1-Click deployment (currently only in V1).
- Create Edit and Delete short URL.
- Keep Statistics of your clicks.
- Budget-friendly and 100% open-source.
- A local database (file) is used for authentification.
- Azure Active Directory AAD (Microsoft Identity) is used for authentification.
How To Deploy Version 1
To deploy YOUR version of Azure Url Shortener you could fork this repo, but if you are looking for the easy way just click on the "Deploy to Azure".
To have all details and alternative deployment refer to the Deployment Details page.
Post Deployment Configuration
A good Url Shortener wouldn't be completed without a custom domain name. To know how to add it and other useful post-deployment configurations refer to the post-deployment-configuration page.
How To Deploy Version 2
Right now the deployment of the Version 2 is possible Headless (just the Azure Function) or paired with TinyBlazorAdmin. It's a static website written in C# webassembly and it's even more budget friendly then v1. However, we are still working at the automation of the deployment.
Until we have a 1-Click deployment you should follow the documented To have all details and alternative deployment refer to the Deployment Details page.
How to Update / Upgrade
You deployed the Azure Url Shortener and it's now running in your Azure Subscription, but you would like to have the new feature(s). Updating your current version is in fact really simple.
Note: Currently there is breaking changes between v1 and v2. It is possible to migrate without losing anything, it's just that the documentation is not done yet. See Issue #196 for more details on the progress.
Update the Azure Functions
Navigate to the Azure portal (azure.portal.com) and select the Azure Function instance, for this project.
From the left panel, click on the Deployment Center (1), then the Sync button(2). This will start a synchronization between GitHub and the App Service (aka Azure Function) local Git.
IF you are using the Admin Blazor Website, repeat the same operation but selecting the App Service with the name starting by "adm".
How To Use It
There are many different ways to manage your Url Shortener, from a direct HTTP call to a fancy website. See the complete list of admin frontends here, with the instructions to deploy and use them. There is also instructions or guidance if you would like to create a new one and collaborate to this project.
There is also a video that does a quick tour of the project.
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 page.
What's Next?
We are working on the version 2.0 (ETA Summer 2020). This version will:
- Use Azure Active Directory (AAD)
- Client side website (more budget friendly) see GitHub project: TinyBlazorAdmin for more details.
- Statistics
- Better Grid to display the URL
Contributing
If you find a bug or would like to add a feature, check out those resources:
- To see the current work in progress: GLO boards 'kanban board'
Check out our Code of Conduct and Contributing docs. This project follows the all-contributors specification. Contributions of any kind welcome!
โจ
Contributors Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
This project was inspire by a project created by Jeremy Likness that you can find here jlik.me.