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
  1. Getting Started
  2. Development and Setup

API Setup

This document is the step by step guide for the setting up of Back End API for your eCommerce portal.

PreviousDevelopment and SetupNextEnvironment Configuration

Last updated 7 months ago

Please ensure that have been installed before proceeding with the API Setup

Step 1 - Extract Source code, you will find api folder, then open your project directory terminal and give below commands

$ npm install

Step 2 - Set up Environment configuration

Step 3 - Import Spurtcommerce.sql(which is in your api folder) in your database and give username,password, database name in .env file.

Step 4- To run the project give the following command in your terminal

$ npm start serve

To build the Spurtcommece api for the server deployment, run the following command in project directory

$ npm run build
Prerequisites