Architecture Overview
A deep dive into the EverShop platform architecture. Learn about our modular monolith design, request lifecycle, module system, and the distinction between the source code and project folder structures.
Configuration Guide
A comprehensive guide to configuring an EverShop application. Learn about configuration layers, environment variables, and all the key settings for your store.
Command-Line Interface
Comprehensive guide to EverShop's command-line interface with detailed explanations of commands for building, developing, and managing your online store.
The Routing System
A deep dive into the EverShop routing system. Learn how routes are defined for API endpoints and pages, how the folder structure works, and how to generate URLs.
The Middleware System
Learn about the middleware system in EverShop. How middlewares work and how to create, add, and remove middleware functions from a route.
Registry and Processors
The Registry and Processor system is EverShop's primary mechanism for extending and transforming data across modules without modifying core code.
Pages
EverShop pages are located in the `pages` folder of each module. Learn how to create pages in your extension.
RESTful API Routes
Learn how to build and manage RESTful API endpoints in EverShop to provide robust backend functionality with proper authentication and validation.
GraphQL
This document explains how the EverShop GraphQL system works, how to create a GraphQL type, and how to extend existing GraphQL types.
Data Fetching
EverShop allows you to fetch data from the server using the GraphQL query language. This document explains how to fetch data from the server and pass it to React Component using GraphQL.
Events and Subscribers
EverShop provides a powerful event system that allows you to subscribe to the event and execute your code when the event is triggered.
Cron Jobs
EverShop provides a powerful cron job system that allows you to schedule tasks to run at specific intervals.
The Database
Learn how to connect to the database, build type-safe queries, and manage transactions in EverShop.
Static File Serving
Learn how EverShop serves static files like images from the public directory and how to properly reference them in your code.
Payment Method Development
Learn how to create a custom payment method for EverShop, from registration to order placement.
Email System
Learn how EverShop sends emails, how to register a custom email service provider, and how to customize email templates and data.
Order Status Management
Understand how EverShop manages order, payment, and shipment statuses, including state transitions and custom status definitions.
Cart Field System
Learn how EverShop's cart field system works and how to add custom fields to carts and cart items.
Fast Refresh
Fast Refresh is a Evershop feature that gives you instantaneous update on edits made to your code. It is enabled by default in the development mode.
Translation
Learn how to translate your EverShop application into different languages and make your theme fully translatable for international customers.