Skip to content

Azure-Samples/dab-swa-library-demo

Repository files navigation

page_type languages products urlFragment name description
sample
azurecli
azstatic-cli
nodejs
javascript
azure
static-web-apps
azure-sql-database
data-api-builder
sample
Jamstack Library App with Azure Static Web Apps, Data API builder, and Azure SQL Database
This sample uses the database connections feature of Azure Static Web Apps to provide CRUD access to database contents with REST, built-in authorizations, and support for database relationships with GraphQL.

Library Demo

A sample app of Static Web Apps with Database connections for a React app and Azure SQL database

Features

This project uses the database connections feature of Static Web Apps to provide the following functionality:

  • CRUD access to database contents with REST or GraphQL
  • Built-in authorization with Static Web Apps authentication
  • Support for database relationships with GraphQL

Getting Started

Prerequisites

  1. An Azure SQL database with the tables created
  2. NodeJS
  3. An Azure Static Web App resource

To get started locally

  1. Clone this repository
  2. Navigate to library directory & open with VSCode
  3. Set the DATABASE_CONNECTION_STRING environment variable to your connection string in your terminal/cmd/powershell. Alternatively, paste your database connection string directly into swa-db-connections/staticwebapp.database.config.json (not recommended) (ensure that you remove this secret from your source code before pushing to GitHub/remote repository)
  4. Run swa start http://localhost:3000 --run "cd library-demo && npm i && npm start" swa-db-connections
    • cd library-demo && npm i && npm start will install needed npm packages and run your React app
    • --data-api-location swa-db-connections indicates to the SWA CLI that your database connections configurations are in the swa-db-connections folder Alternatively, you can start all these projects manually an make use of SWA CLI's other args

You can now use your Static Web App Library Demo Application. It supports authorization, such that anyone logged in with SWA CLI's authentication emulation with the admin role will have CRUD access, while anonymous users are limited to read access. See the configurations detailed in staticwebapp.database.config.json

To deploy

  1. Commit all your changes and push to your repository.
    • You do not need to change your configuration file's data-source object, since this will be overwritten by your Static Web App resource when you connect a database.
    • (If you have paste your connection string directly in your configuration file, ensure that you remove it to avoid making your database connection string public)
  2. Go to your Static Web App resource in the portal. Go to the Database connection tab.
  3. Ensure that your database is ready for connection. It should be configured to accept network requests from Azure services. If you plan to use managed identity as a connection type, ensure that you've configured the managed identity within your database.
  4. Link your database to your default environment. Select your database & enter the credentials.

Troubleshooting

  • Ensure your Azure database is configured to accept network requests
  • Ensure that your configuration files have been placed in your repository and included in your build process.
  • Ensure that your managed identity has been configured within your database.

Screenshots

Home page:

alt text

Non-logged in users receive 403's when they try to Create as configured in swa-db-connections/staticwebapp.database.config.json

alt text

Non-logged in users receive 403's when they try to Delete as configured in swa-db-connections/staticwebapp.database.config.json

alt text

Log in page with admin role

alt text

Non-logged in users receive succesful 201's when they try to Create as configured in swa-db-connections/staticwebapp.database.config.jsonalt text

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •