Skip to main content

#21: Develop With VSCode

ยท 4 min read
Alex Weininger

Welcome to Week 3, Day 7 of #30DaysOfSWA!!

This week has been all about the SWA developer tools. To conclude the week, we'll show how the Azure Static Web Apps extension for VS Code can make using all of these awesome tools easier!


Prerequisites ๐Ÿ› ๏ธโ€‹

  1. Google Chrome installed - we make use of the debugger

  2. Azure Static Web Apps extension for VS Code - View on Marketplace

  3. Azure Static Web Apps CLI - View on GitHub

npm install -g @azure/static-web-apps-cli@latest

1. Getting started ๐ŸŸขโ€‹

  1. Clone one of these repositories, and open it up in VS Code
  1. Run npm install

Running npm install in VS Code

Theme: Cobalt2 Theme Official by Wes Bos

2. Run and debug ๐Ÿžโ€‹

Show automatic debug configurations

  1. Go to the "Run and Debug" view
  2. Click "Show all automatic debug configurations."
  3. In the dropdown, select "Azure Static Web Apps..."
  4. Select the app you want to debug

This will start the Azure Static Web Apps CLI in the VS Code terminal, and launch the Chrome debugger on http://localhost:4280.

Now you can set and hit breakpoints in your frontend code.

Set breakpoints

3. Add API route โšก๏ธโ€‹

Azure Static Web Apps has integrated API support provided by Azure Functions. In order to add and debug an API route, we must install some Azure Functions tools.

  1. Azure Functions extension for VS Code - Install from Marketplace

  2. Azure Functions Core Tools - View on GitHub

npm i -g azure-functions-core-tools@4 --unsafe-perm true

Now, you can add an API route to your app using the command palette (press F1) and searching "Create HTTP Function".

Add HTTP Function

Select a language (I chose JavaScript), then name your Function (I put "hello"). And then an API route will be created for you that you can make requests to at /api/hello.

API route

4. Debug app & API โœจโ€‹

We can debug our API routes and our frontend app simultaneously in VS Code.

Select the "SWA: Run ..." debug configuration and click the green "Run and debug" button.

Run and debug

VS Code will now run your Functions API routes and your frontend. When it's all started, a Chrome window will open at http://localhost:4280.

Set a breakpoint in your Function endpoint.

Function endpoint breakpoint

Go to http://localhost:4280/api/hello in the Chrome window to hit the breakpoint.

Hitting an API breakpoint

5. Next steps ๐Ÿƒโ€โ™€๏ธโ€‹

Now that you got your static web app running locally, you can deploy your static web app to Azure for free.

Troubleshooting ๐Ÿ”โ€‹

If you're having issues, please check out the troubleshooting section in our wiki.

Resources ๐Ÿ”—โ€‹

Next Weekโ€‹

This marks the end of Week 3 of #30DaysOfSWA, with a focus on Developer Tools. Want a visual recap of what we covered .. here you go!! To recap:

  • We provisioned Azure resources - using the Azure Portal and Azure CLI
  • We added automated, cross-browser, e2e testing - using Playwright
  • We built multi-stage deployment pipelines - using Azure DevOps
  • We debugged and audited perf & accessibility - using Edge DevTools on VSCode
  • We got unified local development and cloud deployment - using SWA CLI
  • We explored rich extensions and seamless CLI interactions - using VS Code

Week 3 Visual Roadmap

So what do we have planned for next week?

We've already covered core concepts, usage examples and developer tools -- so that leaves: Best Practices! Join us for the final week of #30DaysOfSWA where we define the end-to-end developer experience, explore various Azure Service integrations to enhance your SWA, dive into a cool case study, and end with a Tips & Tricks series that brings you back full circle to development.

Thanks for sticking with us on this journey!