Skip to content

Latest commit

 

History

History
 
 

portal

README.md

Contoso Real Estate App: Portal Package

IMPORTANT: THIS REPOSITORY IS OPTIMIZED FOR CODESPACES AND TO WORK AS A SET OF COMPOSABLE APPS AND APIS. STANDALONE PACKAGE FUNCTIONALITY IS LIMITED AND MAY REQUIRE ADDITIONAL CONFIGURATION OR DEVELOPMENT

This document will guide you through the prerequisites and commands necessary to setup and preview the portal project, locally on your computer. This document will guide you through the prerequisites and commands necessary to setup and preview the portal project, locally on your computer.

It will also instruct you how to deploy it to Azure Static Web Apps, to publish it to the cloud, independently, using the Azure Static Web Apps CLI.

Prerequisites

IMPORTANT: THIS SCENARIO IS TIGHTLY COUPLED WITH SCENARIO 1. SOME PARTS OF THIS APP MAY NOT WORK AS EXPECTED IF YOU DON'T FOLLOW THE INSTRUCTIONS IN SCENARIO 1.

In order to start the development server for local development or locally browsing the portal site, the following technologies must be installed in your computer:

Enabling the Realtime notifications service

In order to enable the realtime notifications service, you will need to follow the instructions in the ./packages/notifications package. This service is required to enable the realtime notifications feature in the portal.

Once you have the notifications service running, you will need to create and configure the ./packages/portal/.env file with the following variables:

SERVICE_WEB_PUB_SUB_URL="https://<resource-name>.webpubsub.azure.com"
SERVICE_WEB_PUB_SUB_PATH="/clients/socketio/hubs/Hub"

In order to get these values, from the Client URL Generator section, copy the Client Endpoint (e.g. https://<resource-name>.webpubsub.azure.com) and Client Path (e.g. /clients/socketio/hubs/Hub) and update the SERVICE_WEB_PUB_SUB_URL and SERVICE_WEB_PUB_SUB_PATH in ./packages/portal/.env file.

Angular CLI

This project was generated with Angular CLI.

Steps to start the portal

  1. fork or clone the repository locally
  2. assuming you are in the folder containing ./packages/portal, go to the terminal and run
npm run clean:install

at the root level of the repository. This will install all dependencies for all scenarios.

This operation will also install the Azure Static Web Apps CLI. This tool includes a local dev server and emulator, to test the application and the corresponding API together, locally.

  1. assuming you are now in the contoso-real-estate, go to the terminal and run
npm start

Follow the Azure Static Web Apps CLI prompts to complete the configuration.

Your default browser should open a new window with the application running. If you did not pass a port option, it should be running at http://localhost:4280

  1. Go to http://localhost:4280. The application and the API should be running and functional. You should be able to see the homepage and the cards or teasers for the listings. You should be able to navigate to any of the listings detail page by clicking in any of the cards.

Troubleshooting the local setup

  • Q: The application server starts up but I can't see the listings

  • A: Go to http://localhost:7071/api/listings and make sure you see a JSON printed in the browser.

  • Q: The application server starts up but I can't navigate to any of the listings detail pages

  • A: Go to http://localhost:7071/api/listings and make sure you see a JSON printed in the browser

  • Q: The application server starts up but I can't navigate to any of the listings detail pages

  • A: Make sure you are accessing the portal served by the SWA CLI http://localhost:4280 (and not the Angular CLI).

Deploying to Azure with the Azure Static Web Apps CLI

If you want to deploy to Azure using this tool, you will need an active subscription to Azure, to use any of the available regions listed here

  1. Assuming you are in the folder contoso-real-estate/packages/portal go to the terminal and run
swa deploy
  1. Follow prompt instructions.

Troubleshooting the deployment

If the deployment fails

  • Check if you exceeded the maximum quota for free apps. Check the limits and quotas for the free tier here
  • Check that your subscription id and tenant id are correctly configured under contoso-real-estate/packages/portal/.env for variables
AZURE_SUBSCRIPTION_ID=
AZURE_TENANT_ID=
  • Change the region target to an alternative region, if it's unavailable or saturated - select from regions listed here
AZURE_REGION_LOCATION=
  • Check for a configuration file called staticwebapp.config.json, under contoso-real-estate/packages/portal/src/assets/. Make sure to add the following snippet:
{
  // other config: {
  // ... config
  // },
  "platform": {
    "apiRuntime": "node:16"
  }
}
  • Run If your deployment still fails, run
swa deploy verbose=silly

Copy the log and open an issue in our open-source Azure Static Web Apps CLI repository. We will love to hear from you!

Happy coding! 🚀