Spurtcommerce
DocumentAPI ReferenceAdd-ons
Docs
Docs
  • Overview
  • Getting Started
    • Introduction
    • Prerequisites
      • Server Configuration (Minimal)
      • Set up development environment
    • Development and Setup
      • API Setup
      • Environment Configuration
      • Store Front Setup
        • Angular Store Front
        • React Store Front
        • Flutter store front
      • Angular Admin Setup
      • Angular Vendor Setup
  • API Deployment and Setup
    • Deployment From Source Code
    • Deployment From Docker
    • Troubleshooting
  • Frontend Deployment Setup
    • Store Front Setup
      • React Store Front
      • Angular Store Front
      • Flutter Store Front
      • Troubleshooting
  • Front End Angular Admin Setup
    • Angular Admin
    • Troubleshooting
  • Front End Angular Vendor Setup
    • Angular Vendor
    • Troubleshooting
  • For Developers
    • Architecture
      • Back End API Architecture
      • Front-end Architecture
      • Technology stack
    • Performance
      • Benchmark
      • Image Optimzation
      • Load Balancing
      • RabbitMQ
      • Clustering
      • Database Load Balancing
    • Security
    • Testing Reports
      • Unit Testing Report
      • E2E Test Report
      • Vulnerability Test Report
        • Spurt Admin Report
        • Spurt Store Report
        • Spurt Vendor Report
      • Functional Test Report
  • How to Guides
    • Store Language Setup
    • Addon Management
    • Spurtcommerce Microservices Deployment
Powered by GitBook
On this page
  • Infrastructure pre-requisites
  • Frontend Setup
  • Backend Setup
  1. How to Guides

Spurtcommerce Microservices Deployment

PreviousAddon Management

Last updated 11 months ago

This article provides detailed instructions on how to setup Spurtcommerce Ecommerce Microservices solution along with Backend APIs and all associated frontend panels, including the Store Panel, Vendor Panel, and Admin Panel.

Infrastructure pre-requisites

Before diving into the installation process, ensure that your local or server environment meets the necessary infrastructure prerequisites as detailed in this

Note: You can choose to ignore "React Installation" step if you have purchased Angular store.

Frontend Setup

Please follow steps and guidelines detailed in the below links to setup Angular storefront, Vendor Panel & Admin Panel.

Angular Store:

Angular Admin:

Angular vendor:

Backend Setup

  1. Setup RabbitMQ:

  • Ensure latest version of RabbitMQ is installed, running, and accessible.

  • Necessary exchanges, queues, and bindings etc required for the services will be handled by backend application logic during runtime..

  1. Extract the zip file of the backend source-code that you purchased and you should see the below folder structure.

  1. Navigate to each service directory (including /api-gateway folder) and perform the following:

3.1 Install the required dependencies using the following command.

npm install

Above step shall install gRPC modules along with other relvant/applicable node modules as well.

3.2 Import the corresponding SQL database for each service.

3.3 Configure a .env file of each service with the necessary environment variables and this includes:

  • Database credentials (host, port, username, password, database name)

  • RabbitMQ URL (protocol, host, port, username, password)

  • gRPC URL (host, port)

  • API Gateway settings (host, port, routes)

Note: If all services are on the same machine, ensure the gRPC URLs and API Gateway settings in the .env files are set to localhost (i.e retain the default config provided by Spurtcommerce team initially) whereas if you prefer to deploy services on different machines, then update the corresponding .env file with the correct IP addresses or domain names for gRPC and API Gateway and ensure network security groups and firewall rules allow communication between services.

3.4 Start the service using the following command.

npm start serve

After all the above steps are executed, check if the api-gateway is up by running http://localhost:8000

Specific configuration:

Above steps concludes successful installation and setup of Spurtcommerce Microservices based Marketplace solution and "Your Own Marketplace" will be ready-to-use.

"Chat" module related configuration should be done in "Customer Service" .env file. Please check the chat server setup guidelines here

Link
Link
Steps to deploy Angular storefront
Steps to deploy Admin Panel
Steps to deploy Vendor Panel