Skip to main content

My EverShop App Documentation

Build powerful e-commerce experiences with EverShop’s modular architecture. Extend functionality with custom extensions and create beautiful storefronts with themes.

Quick Start

Get your development environment up and running in minutes

1

Install dependencies

Clone the repository and install the required packages:
npm install
2

Configure your environment

Set up your database connection and shop settings in the configuration files:
# Start the setup process
npm run setup
The setup will guide you through database configuration, admin account creation, and initial shop settings.
3

Start development server

Launch the development server with hot-reload:
npm run dev
Your store will be available at http://localhost:3000
4

Create your first extension

Extensions are the building blocks of functionality. Learn how to create custom extensions to add features to your store.

Explore by Topic

Dive into the core concepts powering this e-commerce platform

Extensions

Build custom functionality with the modular extension system

Themes

Create beautiful storefronts with React-based themes

GraphQL API

Query and mutate data with the built-in GraphQL API

Routing

Understand how pages and API endpoints are registered

Configuration

Configure shop settings, extensions, and themes

Event Subscribers

React to system events with custom subscribers

Development Guides

Step-by-step guides for building with EverShop

Creating Extensions

Build custom extensions to add new functionality

API Endpoints

Create REST API endpoints with route configuration

Page Components

Build React components for frontend pages

Cron Jobs

Schedule recurring tasks with cron jobs

API Reference

Comprehensive reference for GraphQL queries, REST endpoints, and configuration

GraphQL API

Query and mutate data with type-safe GraphQL operations

REST API

Access resources through RESTful HTTP endpoints

Ready to build?

Start building your e-commerce platform with EverShop’s powerful extension system

Get Started Now