Deployment From Docker
A brief guide to this workspace, environment files, and how to install and run SpurtCommerce using Docker Compose.
Project layout:
compose.yaml: Top-level Docker Compose configuration used to bring up services.
config/: Environment configs for different frontend/backends and services.
admin/: Admin frontend environment settings.
api/: Backend API environment settings.
seller/: Seller frontend environment settings.
store/: Store (customer) frontend environment settings.
See the examples in the config folder, for example: config/store/.env.
What each config contains (high-level)
admin/.env— admin frontend variables (API_BASE_URL, CHAT_URL, IMAGE_URL, STORE_URL, PLUGIN_URL).api/.env— backend service environment (DB, TypeORM, JWT, mail, URLs, logging, etc.).seller/.env— seller frontend variables (similar to admin frontend).store/.env— store frontend variables (STORE_KEY, INDUSTRY_SLUG, API_BASE_URL, etc.).
Important example variables you will likely edit before starting:
API_BASE_URL— base URL for the backend API.IMAGE_URL— image CDN/resize endpoint.STORE_URL— frontend store host (used by plugins/redirects).Database variables in
api/.env(TYPEORM_HOST, TYPEORM_USERNAME, TYPEORM_PASSWORD, TYPEORM_DATABASE).
Examples (taken from workspace):
Admin / Frontend sample (trimmed):
API / Backend sample (trimmed):
If you need help mapping ports or environment variables from compose.yaml into local
config/*/.env files, tell me which service or variable you want updated and I will adjust the files.
See
config/store/.envfor the store frontend example: config/store/.env.
If you want, I can:
Update the
compose.yamlports or environment stubs for your local IP.Add a
.env.examplefile per component.Create a short troubleshooting script to verify service connectivity (DB and API).
Generated README to help get the project running with Docker Compose.
Overview
This is the official repository of Spurtcommerce. Using these Docker Images, you can easily deploy Spurtcommerce Multi-Vendor Marketplace in your local server.
Start Spurtcommerce with Docker Compose
By following these two simple commands, you can quickly launch Spurtcommerce in your local server.
Additionally, you should have docker and docker-compose installed on your system.
If you have not yet installed Docker in your local server, then follow this first step.
Step 1:
Having already built the Docker images you can run docker compose command
Step 2 :
If the above command gives an error, try running it with sudo:
Spurtcommerce port
our local Spurtcommerce setup is now running with each of the services occupying the following ports:
-p 8000
The port for the spurtcommerce api
-p 3001/admin
Angular Frontend - Admin
-p 3002
Angular Frontend - Seller
-p 3000
Store Frontend - Store
Then SpurtCommerce is ready at:
Admin: http://localhost:3001
Seller: http://localhost:3002
Store: http://localhost:3000
Available Images
**Images / Builds**
Service images and build contexts are defined in the primary Compose file compose.yaml. Inspect compose.yaml to see whether a service pulls an image from Docker Hub (the image: field) or builds locally (the build: field), and to view the exact image names, tags, and ports used by the stack.
If you require any premium support, feel free to write to [email protected].
Last updated