This is version 4 (#549)

* Update time ALL to latest
* .NET Aspire solution
* Azure Container Apps (instead of SWA and Function)
* Deployment with Azure developer CLI (azd) 
* Replace Syncfusion components with Blazor Bootstrap and update chart implementation
* Update GitHub Actions workflow to include 'v-next' branch and clean up indentation
* Add FAQ documentation (planning to deprecate the wiki)
* Update readme and images

Author: fboucher

.github/workflows/azure-static-web-apps-kind-ocean-0b86fe110.yml

@@ -0,0 +1,33 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+      - v-next
+  pull_request:
+    branches:
+      - main
+      - v-next
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: '9.0.x' # Adjust the version as needed
+
+    - name: Install .NET Aspire workload
+      run: dotnet workload update && dotnet workload install aspire
+
+    - name: Restore dependencies
+      run: dotnet restore src/AzUrlShortener.sln
+
+    - name: Build solution
+      run: dotnet build src/AzUrlShortener.sln --no-restore --configuration Release

.github/workflows/build.yml

@@ -20,30 +20,30 @@ Features:
 - 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).
+👉 **[Step by Step Deployment](doc/how-to-deploy.md)** 👈 documentation is available here.
 
-If you want to **Update** or **Upgrade**, please refer to [this page](https://github.com/microsoft/AzUrlShortener/wiki/How-to-Update---Upgrade) (wiki pages). 
+If you want to **Update** or **Upgrade**, please refer to [the faq page](doc/faq.md). 
 
 ## 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. 
+Once deployed, use the admin webApp (aka TinyBlazorAdmin) to create new short URLs. 
 
-We suggest [Tiny Blazor Admin](./src/Cloud5mins.ShortenerTools.TinyBlazorAdmin/README.md); it's a static website. 
+![Tiny Blazor Admin looks](images/tinyblazyadmin-tour.gif)
 
-![Tiny Blazor Admin looks](/Media/TinyBlazorAdmin.gif)
 
-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).
+### Alternative Admin Tool
 
-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). 
+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). 
 
-## 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.
+## Videos
 
 There is also a videos that explains a bit how things works and does a quick tour of the project.
 
@@ -59,10 +59,9 @@ There is also a videos that explains a bit how things works and does a quick tou
 
 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!
+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:
-- A deployment option with everything combined into TinyBlazorAdmin
 - More Statistics
 - QR Code
 - More tracking information (like Country)

Media/TinyBlazorAdmin.gif

@@ -0,0 +1,37 @@
+# Frequently asked questions (f.a.q.)
+
+- [How to Add a Custom Domain](./how-to-add-custom-domain.md)
+- [Add authentication to the admin website](./how-to-deploy.md#add-authentication-to-the-admin-website)
+- [Add a custom domain to the admin website](./how-to-add-custom-domain.md#add-a-custom-domain-to-the-admin-website)
+- [How to migrate your data](./how-to-migrate-data.md)
+- [How to deploy your AzUrlShortener](./how-to-deploy.md)
+- [How to run AzUrlShortener locally](#how-to-run-azurlshortener-locally)
+- [How to update/ redeploy AzUrlShortener](#update-redeploy-azurlshortener)
+- [How does it work?](./how-it-works.md)
+- [Security Considerations](./security-considerations.md)
+
+
+## How to run AzUrlShortener locally
+
+You will need .NET 9, Docker or Podman installed on your machine. From the `scr` directory, run the following command `dotnet run --project Cloud5mins.ShortenerTools.AppHost`. You can also open the solution in Visual Studio or Visual studio Code and use F5, make sure the `Cloud5mins.ShortenerTools.AppHost` project is set as starting project.
+
+
+## Update/ redeploy AzUrlShortener
+
+In a terminal, navigate to the `src` directory of your project.
+
+```bash
+cd src
+```
+
+To avoid affecting custom domains when deploying Azure Container Apps use the following command. 
+
+```bash
+azd config set alpha.aca.persistDomains on
+```
+
+If you haven't already, log in to your Azure account with azd auth login. You can re-deploy the application with the following command:
+
+```bash
+azd up
+```

README.md

@@ -0,0 +1,39 @@
+How It Works
+============
+
+The backend is using Azure Functions and Azure Table Storable this page will explains how they work together in this tool.
+
+![Global Diagram](../images/global_diagram_idea_v3b.jpg)
+
+## Azure Functions
+
+Azure Functions were the perfect match for this project because when you use a dynamic plan you are charged only when the function is running. In our case, it's only a few seconds at the time. To know more read [Azure Function Pricing](https://azure.microsoft.com/en-us/pricing/details/functions/)
+
+### Function: UrlRedirect
+
+This function returns a HTTP Redirect to the URL. You can call it directly doing an HTTP request of type POST or GET passing the vanity at the end of the URL. The Azure Function Proxy will call Function passing the parameter.
+
+For example, if the domain is *c5m.ca* and the vanity is "project", the request `c5m.ca/2w` will call "UrlRedirect/{shortUrl}" where `shortUrl` is equal to "project". end the result will be a redirect to the long URL save in the storage.
+
+Every time the Azure Function is called it will increment the click count and save the timestamp when this call appends.
+
+## Azure Table Storage
+
+The [Azure table storage](https://docs.microsoft.com/en-us/azure/storage/tables/) are the data store in this project. They are a very convenient service to keep structured NoSQL data in the cloud. They are also typically lower in cost than traditional SQL for similar volumes of data.
+
+You can explore the Azure Table storage from Azure portal or using the [Azure Storage Explorer](https://docs.microsoft.com/en-us/azure/vs-azure-tools-storage-manage-with-storage-explorer?tabs=windows#overview) it's a nice free tool that is available on all platforms (MacOS, Linux, Windows).
+
+There are two tables that will be automatically created at the first call.
+
+### Table: ClickStats
+
+The ClickStats table get a new entry at every call of the Azure Function **UrlRedirect** with the Datetime value.
+
+
+### Table: UrlDetails
+
+The UrlDetails table has the information about all the URLs created. The Vanity, URL, and number of clicks.
+
+## Security Considerations
+
+Review [Security Considerations](./security-considerations.md) and choose and implement an appropriate authorization approach.

doc/faq.md

@@ -0,0 +1,15 @@
+# How to Add a Custom Domain
+
+From the Azure Portal, Open the Azure COntainer Apps named `azfunc-light`. This is the one doing the redirect, this is where you want yout custom domain to be used.
+
+From the left menu, select **Custom domains** and click on **Add custom domain**.
+
+![Add custom domain](../images/add-custom-domain.png)
+
+Follow the instructions to add your custom domain. Note that it may takes a few minutes for the domain to all be setup. Once it is, you should see the domain listed in the custom domains list withthe green check mark.
+
+
+## Add a custom domain to the admin website
+
+To make it easier to find the TinyBlazorAdmin website, you can also add a custom domain to it. From your Domain provider (GoDaddy, NameCheap, etc.), you can set a forwarding subdomain to the admin website. For example, if you want to use `admin.yourdomain.com`, you can set a forwarding rule to the URL of the admin website (e.g., `https://admin-azfunc-light.azurecontainerapps.io`). This way, you can access the TinyBlazorAdmin website using your custom domain.
+

doc/how-it-works.md

@@ -0,0 +1,72 @@
+# How to deploy your AzUrlShortener
+
+## First thing first
+
+### 👉 **Fork this repository** into your own account
+
+> To Fork GitHub repository click on the Fork button on the top right of the screen.
+
+![Click on the button Fork](../images/click-fork.png)
+
+Provide a name. It can be anything, it just needs to be unique in your account (you can keep AzUrlShortener if you want). Add a description it you want and click the button **Create repository from template**. 
+
+![Give it a name description and click Create](../images/fork-details.png)
+
+After a few seconds, you should now be in your version of the AzUrlShortener project. If you need more detail have a look to this GitHub doc: [Fork a repo](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo).
+
+> Make sure you are currently in YOUR GitHub repository.
+>
+>![This should be YOUR repo](../images/your-account.png)
+
+
+## Prerequisites
+
+- [Docker Desktop](https://www.docker.com/products/docker-desktop/) or [Podman](https://podman.io/getting-started/installation)
+- [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd)
+
+
+## Deploying to Azure
+
+1. In a terminal, navigate to the `src` directory of your project.
+
+	```bash
+	cd src
+	```
+1. If you haven't already, log in to your Azure account with `azd auth login`.
+1. To avoid affecting custom domains when deploying Azure Container Apps use the following command. This mostly useful if you are re-deploying, or updating an existing application. If you don't have any custom domain assign to the Azure Container Apps, you can still execute the command, but it's optional.
+   
+	```bash
+	azd config set alpha.aca.persistDomains on
+	```
+
+1. Provision all required Azure resources and deploy the application with the following command:
+
+	```bash
+	azd up
+	```
+
+1. Get the application URL
+
+After the deployment is complete, you will see the URLs of your applications in the terminal; the one starting by `https://admin` is the admin tools (aka TinyBlazorAdmin), and the one starting with `https://azfunc-light` is the redicrect service. There is also many details about the resources created in Azure, and a link to the .NET Aspire dashboard.
+
+![azd deployment result](../images/deployment-result.png)
+
+## Add authentication to the admin website
+
+The app is now deployed, but it does not have authentication enabled. Navigate to the [Azure Portal](https://portal.azure.com/), and find the Resource Group you just deployed (e.g., rg-azUrl-dev). From there, select the Container App named **admin**.
+
+![select the Container App admin](../images/select-admin-container-app.png)
+
+From the left menu, select **Authentication** and click **Add identity provider**.
+
+![select Authentication](../images/auth-and-provider.png)
+
+You can choose between multiple providers, but let's use Microsoft since it's deployed in Azure and you are already logged in. Once Microsoft is chosen, you will see many configuration options. Select the recommended client secret expiration (e.g., 180 days).
+
+You can keep all the other default settings. Click **Add**. After a few seconds, you should see a notification in the top right corner that the identity provider was added successfully.
+
+Voila! Your app now has authentication.
+
+Next time you navigate to the app, you will be prompted to log in with your Microsoft account. Notice that your entire app is protected. No page is accessible without authentication.
+
+The first time you log in, you will see a Permissions requested screen. Check the **Consent** checkbox, and click **Accept**.

doc/how-to-add-custom-domain.md

@@ -0,0 +1,11 @@
+# How to migrate your data
+
+The easiest way to migrate your data between account or from an ealier version of AzUrlShortener is to use the **Azure Storage Explorer** to export the data as a CSV files and then import it into the new account or version.
+
+Azure Storage Explorer is a free tool to manage your Azure cloud storage resources (aka your short URLs) from your desktop. It’s a cross-platform and can be downloaded [here](https://azure.microsoft.com/en-us/products/storage/storage-explorer/). 
+
+In the resources deployed to Azure there will be 2 storage accounts. One for the redirect service (azfunc-light) and one acting as the data store. That last one is the one you want to use for the data migration. The name of that storage account should start wirh `urldata`. 
+
+You need to expot to CSV the following tables:
+- UrlsDetails: This table contains the details of the short URLs, including the original URL, the short URL, schedules, etc.
+- ClickStats: This table contains the clicks informations.

doc/how-to-deploy.md

@@ -0,0 +1,55 @@
+Azure Storage Explorer is a free tool to manage your Azure cloud storage resources (aka your short URLs) from your desktop. It’s a cross-platform and can be downloaded [here](https://azure.microsoft.com/en-us/products/storage/storage-explorer/). 
+
+Once installed, you need to configure it to access your Azure account. You can do this by clicking on the Open connection dialog the **DC plug** icon in the top left corner, then select the Azure Subscription option.
+
+![Azure Storage Explorer, Open connection dialog](../images/storageexplorer-selectresource.png)
+
+And follow the steps to login to your Azure account.
+
+## Find the URLs Storage table
+
+To find the table where the URLs data is saved, expend your subscription (with the key icon) in the tree view. Expand the Storage accounts, your account (probably starting by 'shortenertool' and ending with 'sa'), tables, and finally look for. `UrlsDetails`
+
+![Finding the UrlsDetails table in Azure Storage Explorer](../images/storageexplorer-tree.png)
+
+Pro tip: You can right-click on the table and select `Pin to Quick Access` to create a shortcut to it.
+
+## Create a new Short URL
+
+To create a new URL, make sure the `UrlsDetails` table is selected (directly or using the quick access), then click on the **+ Add** button in the top menu.
+
+![Creating a new URL in Azure Storage Explorer](../images/storageexplorer-addentry.png)
+
+The *Add Entity* dialog window will open, You will need to fill it in order to create the URL.
+
+- **Partition key:** (Required) This MUST be the first character of your short URL (aka RowKey).
+- **RowKey:** (Required) The short URL.
+- **Id:** Never set any value in this field, this is used by the system and URLs don’t need then.
+- **Clicks:** Don’t set any value in this field, it will be incremented automatically when your short URL is used.
+- **Url:** (Required) The original (aka long) URL.
+- **Title:** (Optional) This is for your convenience. Write something that helps you understand what the URL is from.
+- **Is Archived:** Since we create a new URL leaves that field empty.
+
+> Alternatively, you could only add the properties: Partition key, RowKey, and the Url redirect will still work.
+
+Once you are done, click on the **Insert** button. Congratulations, you have created a new URL, you can test it to be sure.
+
+## Update an existing Short URL
+
+First, we need to search for the URL that we want to edit, and we do this by executing a query. 
+
+![Execute a query in Azure Storage Explorer](../images/storageexplorer-updateexisting.png)
+
+Click on the `Query` button in the top menu. Now depending on the information, you have changed the search parameters. 
+
+Use the RowKey if you have the `vanity` (the end of the short URL), and set the PartitionKey equal to the first character of that vanity.
+
+If you want to search with by Title, like in the screenshot, change one of the fields by `Title` and remove the other by clicking on the “X” button on the left of the row.
+
+> Note: There is no wildcard search in Azure Storage Explorer, so you need to use the exact value.
+
+Once you are ready, click on the triangle (play) button, to execute your query. If you did it correctly, you will see the URL you are looking for. You can click the **Edit** button, or double-click the result row to edit it.
+
+
+You are invited to go into the [Discussion](https://github.com/microsoft/AzUrlShortener/discussions) tab to share your feedback, ask questions, and suggest new features!
+