Quick start | Environment | Key Features | Page Previews | Demo
English | 简体中文
## AI Agent Installation Guide If you are an AI Agent installing or deploying this project, please read [AGENTS.md](AGENTS.md) first and follow its instructions. For automated installation, you can also review and use [install.sh](install.sh). ## BeikeShop — Open Source PHP & Laravel Ecommerce Platform BeikeShop is an open-source ecommerce platform built on PHP and Laravel, designed for developers and businesses to launch **self-hosted** online stores with lightning-fast deployment and full control over code, data, and infrastructure. It offers a highly intuitive, **out-of-the-box** solution that enables users to move from installation to a fully functional store with ease and efficiency. The platform provides a comprehensive ecommerce foundation—including product management, shopping cart, checkout, payments, shipping, multi-language, multi-currency support, and **REST APIs**—making it the ideal choice for global independent online stores. Engineered for seamless secondary development, BeikeShop follows a **modular, event-driven architecture**. By utilizing a robust **Hook and Event-based system**, developers can extend features, build plugins, and integrate third-party services through **non-intrusive customization**, ensuring the core code remains untouched for easy maintainability and upgrades. --- ## Tech Stack - **Language**: PHP 8.2+ - **Framework**: Laravel 12 - **Frontend**: Blade Templates, Vue.js - **Architecture**: MVC, Modular, Event-driven - **Security & Logic**:Middleware, Webhook Engine - **Frontend:** Blade / vue / jQuery / sass / Bootstrap - **Database**: MySQL, PostgreSQL - **Deployment:** Docker * * * ## Use Cases - PHP / Laravel ecommerce projects - Custom online stores - International ecommerce - Open‑source ecommerce learning and development --- ## Why BeikeShop? - **100% Open-Source:** Full ownership of code and data. - **Laravel-Based:** Standardized for performance and security. - **Low Maintenance:** Stable, production-ready, and cost-effective. - **Developer-Friendly:** Modular architecture for fast customization. - **Lightweight:** Agile alternative to bloated ecommerce platforms. --- ## Live Demo - **Frontend Demo**: https://demo.beikeshop.com/ - **Admin Demo**: https://demo.beikeshop.com/admin/ - Email: demo@beikeshop.com - Password: demo --- ## Quick Start BeikeShop can be installed via **package distribution**, **source code**, or **Docker**. ### I. Package Installation 1. Download BeikeShop: https://beikeshop.com/download 2. Upload and unzip the package on your server. 3. Set the `public` directory as the web root. 4. Visit the site in your browser and follow the installation wizard. 5. Installation guide: https://docs.beikeshop.com/en/install/bt.html 6. For upgrades, overwrite files (keep `.env`) and run: ```bash php artisan migrate ``` ### II. Source Code Installation ```bash git clone https://github.com/beikeshop/beikeshop.git cd beikeshop composer install cp .env.example .env php artisan key:generate npm install npm run prod php artisan beikeshop:install ``` Set the `public` directory as the web root. For upgrades: ```bash git pull composer install php artisan migrate ``` ### III. Docker Installation 1. Install Docker & Docker Compose [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) 2. Clone this repository and enter the project directory: ```bash git clone https://github.com/beikeshop/beikeshop.git cd beikeshop ``` 3. Run the automatic installer: ```bash chmod +x install.sh ./install.sh ``` Or start the bundled Docker Compose profile manually: ```bash cp .env.example .env printf "\nAPP_CODE_PATH=.\nDB_HOST=mysql\n" >> .env docker compose --profile nginx up -d --build docker compose exec nginx composer install docker compose exec nginx php artisan beikeshop:install --force ``` Detailed guide: [https://docs.beikeshop.com/en/install/docker.html](https://docs.beikeshop.com/en/install/docker.html) --- ## Documentation * Official Website: [https://www.beikeshop.com](https://www.beikeshop.com) * Documentation: [https://docs.beikeshop.com/en/](https://docs.beikeshop.com/en/) --- ## Environment Requirements - **Independent Server** (shared hosting not supported) - **OS**: Ubuntu 22+ / CentOS 8.5 - **PHP**: 8.2+ - **Database**: MySQL 5.7+ - **Web Server**: Nginx 1.10+ / Apache 2.4+ ### Required PHP Extensions BCMath, Ctype, cURL, DOM, Fileinfo, GD, iconv, JSON, Mbstring, OpenSSL, PCRE, PDO, SimpleXML, Tokenizer, XML, ZIP --- ## Key Features - **Open Source:** 100% open-source with full ownership of source code and data. - **Easy to Use:** Designed for rapid deployment, allowing you to go from installation to a live store in minutes. - **Laravel Framework:** Built on Laravel 12, adhering to standard MVC architecture and industry best practices. - **Modern UI:** Clean, high-conversion storefront and an intuitive admin dashboard for a seamless user experience. - **Complete Workflow:** Out-of-the-box support for products, cart, checkout, payments, shipping, and customer management. - **Global Commerce:** Native multi-language and multi-currency support, ideal for international online stores. - **Modular Architecture:** Decoupled design allowing functional expansion via plugins without modifying the core. - **Events & Webhooks:** Flexible event-driven customization through Webhooks and Listeners for seamless integration. - **Secure & Reliable:** Robust security with role-based access control (RBAC) and strict data validation. - **Developer-Friendly & REST APIs:** Clean codebase with comprehensive REST APIs for headless commerce and mobile apps. - **ERP & Integration Ready:** Easy connection with global payment gateways, logistics, and mainstream ERP systems.  --- # Store Preview
