/azure-sql-db-todo-mvc

Full-Stack implementation of the famous ToDoMVC: Vue.js, .NET Core REST API, Azure SQL

Primary LanguageHTMLMIT LicenseMIT

page_type languages products description urlFragment
sample
nodejs
javascript
tsql
sql
json
azure
vs-code
azure-sql-database
azure-functions
azure-web-apps
TodoMVC Sample app Full Stack implementation using Azure Static WebApps, Azure Functions, Node, Vue.Js and Azure SQL (full JSON support)
azure-sql-db-todo-mvc

TodoMVC Sample App Full Stack Implementation

License

Serverless Full Stack implementation on Azure of ToDoMVC app.

Azure Static WebApps, Azure Functions, Node and Azure SQL

The implementation uses

  • Azure Static WebApp: to bind everything together in one easy package, natively integrated with GitHub CI/CD pipeline
  • Vue.Js as front-end client
  • Azure Function for providing serverless back-end infrastructure
  • NodeJS for the back-end logic
  • Azure SQL as database to store ToDo data
  • GitHub Actions to Deploy the full-stack website (thanks to Azure Static WebApps)

Implementation Details

Folder structure

  • /api: the NodeJs Azure Function code used to provide the backend API, called by the Vue.Js client
  • /client: the Vue.Js client. Original source code has been taken from official Vue.js sample and adapted to call a REST client instead of using local storage in order to save and retrieve todos
  • /database: the T-SQL script needed to setup the object in the Azure SQL database. Take a look at the Stored Procedure to see how you can handle JSON right on Azure SQL

More details are available in this blog post: TodoMVC Full Stack with Azure Static Web Apps, Node and Azure SQL

Setup Database

Execute the /database/create.sql script on a database of your choice. Could be a local SQL Server or an Azure SQL running in the cloud. Just make sure the desired database is reachable by your local machine (eg: firewall, authentication and so on), then use SQL Server Management Studio or Azure Data Studio to run the script.

Of course if you want to deploy the solution on Azure, use Azure SQL.

If you need any help in executing the SQL script on Azure SQL, you can find a Quickstart here: Use Azure Data Studio to connect and query Azure SQL database.

If you need to create an Azure SQL database from scratch, an Azure SQL S0 database would be more than fine to run the tests.

az sql db create -g <resource-group> -s <server-name> -n resiliency_test --service-objective S0

Remember that if you don't have Linux environment where you can run AZ CLI you can always use the Cloud Shell. If you prefer to do everything via the portal, here's a tutorial: Create an Azure SQL Database single database.

If you are completely new to Azure SQL, no worries! Here's a full playlist that will help you: Azure SQL for beginners.

Running local

Now use the /api/.env.template file to create an .env file and add the correct information needed to access your SQL Server or Azure SQL.

Details on how to run Azure Static WebApps locally can be found here:

Set up local development for Azure Static Web Apps Preview

Long story short (make sure you have installed all the prerequisites mentioned in the link above):

  • Run Azure Function from within Visual Studio Code (just hit F5 on the /api folder)
  • Serve /client/index.html using Visual Studio Code Live Server

Running on Azure

This is the amazing part of using Azure Static WebApps. Deploying to Azure is completely automated via GitHub actions.

  1. Fork this repository
  2. Open the Azure Portal
  3. Create a "Static Web App" resource and follow the instruction here: Building your first static web app in the Azure portal, but:
    • When asked for GitHub repo details, point to the forked repo you just created
    • Select "main" as branch
    • Select "Custom" in the "Build Presets" dropdown
    • Set client as "App location"
  4. Wait for resource creation and GitHub action completion. Once the resource is ready, click on "Go to Resource".
  5. Be patient, now GitHub Action will kick in and deploy the full-stack website. It will take a couple of minutes.
  6. Relax.
  7. Grab some coffee or tea.
  8. Drink it.
  9. Click on "Functions" and you should be able to see the todo function listed.
  10. Go to the "Configuration" tab and add the same key and values that you have in your .env file you created earlier for local execution.
  11. Go to "Overview" and click on "Browse" to open your website. Done!

Azure Static Web App Preview

Azure Static Web App are in Preview and at the moment only support a Free tier...which is absolutely great so that you can try them for free, but of course don't expect great performances. REST API response will be in the 500 msec area. Keep this in mind if you are planning to use them for something different than testing. If you need better performance right now and cannot when for when Azure Static Web App will be out of preview, you can always deploy the REST API using plain Azure Functions where you can have amazing scalability and performance.