Skip to main content

Knowledge Base

A collection of articles and tutorials to help you get the most out of your development experience with the EverShop platform.

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.

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 what a database is and how to work with database in EverShop. Create and modify PostgreSQL database by following this tutorial.

Database Migration

Learn how to use migration scripts to upgrade your database schema

Static File Serving

Learn how EverShop serves static files like images from the public directory and how to properly reference them in your code.

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.