Jamstack Todo App with Azure Static Web Apps, Data API builder, and Azure SQL Database
A sample Todo app built with Vue.js that uses Azure Static Web Apps, Data API builder and Azure SQL Database.
The Todo application allows to
- Create either public or private todos
- Update or delete todos
- Mark a todo as completed
- Drag and drop to reorder todos
it uses the following features
- Backend REST API via Data API builder
- Authentication via Easy Auth configured to use GitHub
- Authorization via Data API builder policies
- Data API builder hosted in Azure via Static Web Apps "Database Connections"
Local development
Fork the repository and clone it to your local machine.
Make sure you have the .NET Core 6, Node 16 and Static Web Apps CLI installed.
Deploy the database
Deploy the database project to an SQL Server or Azure SQL Emulator instance using VS Code Database Projects extension or manually using the sqlpackage tool.
If you don't have a SQL Server or Azure SQL Emulator installed locally, you can use the updated sqlcmd tool download the latest version of SQL Server and run it withint a container. (Note: make sure you have Docker installed on your machine first)
Install the sqlcmd tool, using the documentation available here.
Then download the latest version of SQL Server:
sqlcmd create mssql --accept-eula --user-database TodoDB --context-name todo-demo
once download is finished, make sure the container is running:
sqlcmd start todo-demo
Get the connection string via
sqlcmd config connection-strings
and the copy the ADO.NET connection string to the clipboard. It will look like this:
Server=<server>;Initial Catalog=master;Persist Security Info=False;User ID=<admin-user>;Password=<admin-password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;
Now create a .env text file and paste the connection string in there, so that the value it is assigned to the AZURE_SQL_DEPLOY_USER environment variable. It should look like this:
AZURE_SQL_DEPLOY_USER='Server=<server>;Initial Catalog=master;Persist Security Info=False;User ID=<admin-user>;Password=<admin-password>;MultipleActiveResultSets=False;Encrypt=True;TrustServerCertificate=True;Connection Timeout=30;'
in the .env file just created, replace the Initial Catalog value from master to TodoDB.
The deploy-db.ps1 script can be used to deploy the database to a local SQL Server instance or Azure SQL Emulator. It will create a new database called TodoDB and a new user called todo_dab_user.
Run the app locally
Once database has been deployed, build the Vue fronted via
swa build
If you haven't create an .env file yet, create one in the root folder, and the AZURE_SQL_APP_USER environment variable to set it to the connection string pointing to the local SQL Server instance or Azure SQL Emulator:
AZURE_SQL_APP_USER='Server=<server>;Database=TodoDB;User ID=<username>;Password=<password>;TrustServerCertificate=true;'
if you have used the provided script to deploy the database, the connection string will be:
AZURE_SQL_APP_USER='Server=<server>;Database=TodoDB;User ID=todo_dab_user;Password=rANd0m_PAzzw0rd!;TrustServerCertificate=true;'
please notice that the <server> value is the same as the one used to deploy the database. If you used sqlcmd to create the database, use sqlcmd config connection-strings to see that <server> is for you. If you only have one instance of SQL Server installed, it will be localhost.
Then start the app locally using the following command:
swa start --data-api-location ./swa-db-connections
Deploy to Azure
Make sure you have the AZ CLI installed.
Setup the Static Web App resource
Create a Resource Group if you don't have one already:
az group create -n <resource-group> -l <location>
then create a new Static Web App using the following command:
az staticwebapp create -n <name> -g <resource-group>
once it has been created, get the Static Web App deployment token:
az staticwebapp secrets list --name <name> --query "properties.apiKey" -o tsv
Take the token and add it to the repository secrets as AZURE_STATIC_WEB_APPS_API_TOKEN.
Get the connection string to Azure SQL DB
Create a new Azure SQL Server if you don't have one already:
az sql server create -n <server-name> -g <resource-group> -l <location> --admin-user <admin-user> --admin-password <admin-password>
and set yourself as the AD admin. To do that get your user object id:
az ad signed-in-user show --query objectId -o tsv
and get the display name:
az ad signed-in-user show --query displayName -o tsv
The create the AD admin in Azure SQL server:
az sql server ad-admin create --display-name <display-name> --object-id <object-id> --server <server-name> -g <resource-group>
Make sure that Azure Services can connect to the created Azure SQL server:
az sql server firewall-rule create -n AllowAllWindowsAzureIps -g <resource-group> --server <server-name> --start-ip-address 0.0.0.0 --end-ip-address 0.0.0.0
Make sure to read more details about how to configure the firewall here: Connections from inside Azure
Get the connection string (don't worry if the TodoDB database doesn't exist yet, it will be created later automatically):
az sql db show-connection-string -s <server-name> -n TodoDB -c ado.net
Replace the <username> and <password> in the connection string with those for a user that can perform DDL (create/alter/drop) operations on the database, and then create a new secret in the repository called AZURE_SQL_CONNECTION_STRING with the value of the connection string.
Push the repository to GitHub
Push the repo to GitHub to kick off the deployment.
Configure the Static Web App Database Connection
Once the deployment has completed, navigate to the Static Web App resource in the Azure Portal and click on the Database connection item under Settings. Click on Link existing database to connect to the Azure SQL server and the TodoDB that was created by the deployment.
You can use the sample application user that is created during the database deployment phase:
- User:
todo_dab_user - Password:
rANd0m_PAzzw0rd!
Done!
Use your browser to navigate to the Static Web App URL and start using the app.