Azure-Samples/contoso-real-estate

[!WARNING] ⚠️ THIS REPOSITORY IS NOW ARCHIVED AND NO LONGER MAINTAINED ⚠️ The code-base is no longer maintained and deployability with the Azure Developer CLI is not guaranteed.

Thank you for your interest!

Enterprise-grade Reference Architecture for JavaScript

This repository contains the reference architecture and components for building enterprise-grade modern composable frontends (or micro-frontends) and cloud-native applications. It is a collection of best practices, architecture patterns, and functional components that can be used to build and deploy modern JavaScript applications to Azure.

[!IMPORTANT] The application code is meant to serve as a reference. Please incorporate your security governance, audits and conventions before productionizing.

Supported Application Scenarios

The following scenarios are part of the application sample

• AI Chatbot integration (RAG Pattern)

• Payments integration with Stripe

• Real-time Notifications

• Portal application, a main portal entry point, featuring listings, favorites, user authentication and profile

• Headless CMS and blog

Table of Contents

You can navigate through the documentation using the table of contents below:

• Enterprise-grade Reference Architecture for JavaScript
  • Table of Contents
  • Architecture Diagram
  • Simplified Flow Diagram
  • Components
    • Frontend
    • Backend
    • DevOps
    • Developer tools
  • Development environment
  • AI chatbot integration
  • Usage costs
  • Project structure
  • Deploy to Azure
    • Prerequisites
    • Deploy to Azure
    • Configure CI-CD
    • Clean up resources
  • Developer guidelines
  • Want to help?

Architecture Diagram

Simplified Flow Diagram

flowchart TD
    %%

    subgraph Internet
    Portal[https://portal.contoso.com]
    Blog[https://blog.contoso.com]
    CMS[https://cms.contoso.com]
    Stripe[https://stripe.contoso.com]
    API[https://api.contoso.com]
    end

    subgraph Azure API Management
    APIM(API Gateway)
    end

    subgraph Azure Static Web Apps
    SWA_Angular([Angular])
    end

    subgraph Azure Functions
    Functions([Node.js])
    end

    subgraph Azure Container Apps
    ACA_Next([Next.js])
    ACA_Strapi([Strapi])
    ACA_Stripe([Stripe])
    end

    subgraph Database/Storage
    DB_PostresSQL[(PostgreSQL - Strapi)]
    DB_Mongo[(MongoDB - Portal)]
    Storage([Azure Blob Storage - CMS])
    end

    Portal --> SWA_Angular -- "portal.contoso.com/api/**" --> APIM -- "portal.contoso.com/api/**" --> Functions

    Blog -- "blog.contoso.com" --> ACA_Next -. "Strapi API" .-> ACA_Strapi

    CMS -- "cms.contoso.com" --> ACA_Strapi
    ACA_Strapi -- "read/write" ----> DB_PostresSQL -- "read only" --> Functions
    ACA_Strapi -- "upload" --> Storage

    API --> APIM -- "api.contoso.com" --> Functions <-- "read/write" --> DB_Mongo

    Stripe ---> APIM -- "stripe.contoso.com" --> ACA_Stripe <-. "validate payment (through APIM)" .-> Functions

    %% Portal
    linkStyle 0 stroke:pink
    linkStyle 1 stroke:pink
    linkStyle 2 stroke:pink

    %% Blog
    linkStyle 3 stroke:blue
    linkStyle 4 stroke:blue
    linkStyle 5 stroke:blue

    %% CMS
    linkStyle 5 stroke:red
    linkStyle 6 stroke:red
    linkStyle 8 stroke:red

    linkStyle 7 stroke:lime
    linkStyle 9 stroke:lime
    linkStyle 10 stroke:lime
    linkStyle 11 stroke:lime

Components

Frontend

• Angular - The Portal application used to view and book listings.
• Next.js - The Blog application used to view and create blog posts.
• Playwright - The end-to-end testing of the Portal application.
• Azure Static Web Apps - The hosting of the Portal application.

Backend

• Strapi - The CMS application used to manage the data for the Portal and Blog applications.
• Stripe - The payment processing.
• Fastify - The API used that interfaces with the Stripe API and Portal application.
• Azure Functions - The API used to communicate with Portal application.
• MongoDB for Azure Cosmos DB - The database used to store the data for the Portal application.
• Azure Database for PostgreSQL - The database used to store the data for the CMS application.
• Azure Storage - The storage used to store the data for the CMS and Blog application.
• Azure Container Apps - The hosting of the Blog, Stripe and Strapi APIs.
• Azure Application Insights - Monitoring and accessing logs for the applications and APIs.

In order use API Management, please set the boolean flag useAPIM on the main bicep file to true. This will provision the API Management instance and configure the APIs to use it. Please note that this will incur additional costs and the provisioning process may take up to 40 minutes.

DevOps

• Azure CLI - Provisioning, managing and deploying the application to Azure.
• GitHub Actions - The CI/CD pipelines.
• Azure Developer CLI - The CI/CD pipelines.

Developer tools

• Visual Studio Code - The local IDE experience.
• GitHub Codespaces - The cloud IDE experience.
• Azure Static Web Apps CLI - Accelerates the process of building cloud apps on Azure.

Development environment

This project is optimized for use with GitHub Codespaces, a development environment hosted in the GitHub cloud. Here is how to get started:

1. Fork this repository.
2. Create a new GitHub Codespaces from your fork. This will automatically provision a new Codespaces with all the required dependencies preinstalled and configured.
3. Open the terminal and run npm install && npm start to start the development servers. Note: Codespaces will show a series of windows on the right side of the screen while starting all servers. This is normal and expected.
4. Once all dev servers have started, the following URLs will be available:

Note: The URLs above are just examples. The URLs will be different for your fork. The ports however will be the same.

AI chatbot integration

The Contoso Real Estate application can be integrated with an AI support chatbot built using Azure OpenAI.

For more details about enabling the chatbot integration, see this section.

Usage costs

Github Codespaces usage is billed either to an organization or to the user creating it. There are limits to the number of concurrent codespaces you can create or run, so here are a few things to keep in mind:

• Personal accounts get a free monthly usage quota of 120 hours and 15GB storage - enough to explore this project!
• You can lookup current usage or set spending limits on your profile - to ensure you don't accidentally exceed your quota or budget.
• We recommend you delete codespaces you are not actively using, and configure default retention periods to maximize usage of your free quota and minimize costs for paid usage.

Project structure

The project is using npm workspaces. The project structure is as follows:

• packages/ - contains all the packages
  • api - contains the serverless Azure Functions API.
  • portal - contains the Angular web portal.
  • blog - contains the Next.js blog.
  • blog-cms - contains the Strapi CMS.
  • docs - contains the Developer Guide website
  • stripe - contains the Stripe webhook.
  • testing - contains the Playwright tests.

Deploy to Azure

Prerequisites

This project uses GitHub Codespaces as the main development environment. The following steps assume you are using GitHub Codespaces. If you are not using GitHub Codespaces, you can open the project in a Dev Container locally following the instructions here.

Deploy to Azure

This project uses Azure Developer CLI (azd) to provision infrastructure, package, and deploy the application to Azure. Running the following commands will get you started with deployment.

# Login to azd. Only required once per install.
# If the command fails, try using the --use-device-code flag
azd auth login

# Provision infrastructure and the azd development environment
azd provision

# Package the app using the environment variables in .azure/env + deploy the code on Azure
azd deploy

The --use-device-code is used to log in by using a device code instead of a browser, this may resolve any browser issues while logging in. For more information on when & why to use flags, check here

If you encounter issues with the Azure Developer CLI, please open an issue here.

Important: It is mandatory to run these azd commands in this order. Provisioning first will create the azd development environment and outputs the .env file with the required environment variables. Packaging will package the application using some of the environment variables from the .env file.

Deployment region: Your deployment may fail if the region you selected is unavailable for provisioning specific resources. We recommend using westeurope as your target region since that has been currently validated for all services.

Configure CI-CD

Use the following command to configure the CI-CD pipelines:

azd pipeline config --auth-type client-credentials

Clean up resources

When you are done, you can delete all the Azure resources created with this template by running the following command:

azd down

Developer guidelines

The project has a standalone Developer Guide defined under packages/docs and implemented as an interactive website using the Docusaurus platform. To learn more about it, go here.

Want to help?

Want to file a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues in the list: community-help.