|
| 1 | +<p align="center"> |
| 2 | + <img src="https://raw.githubusercontent.com/beikeshop/beikeshop-resource/refs/heads/master/img/banner.jpg" alt="BeikeShop - An Open Source, User-Friendly Cross-Border E-commerce Platform" style="width:100%;max-width:900px;"> |
| 3 | +</p> |
| 4 | + |
| 5 | +<p align="center"> |
| 6 | + <u><a href="#quick-start">Quick start</a></u> | |
| 7 | + <u><a href="#environment-requirements">Environment</a></u> | |
| 8 | + <u><a href="#key-features">Key Features</a></u> | |
| 9 | + <u><a href="#page-previews">Page Previews</a></u> |
| 10 | +</p> |
| 11 | + |
| 12 | +<div align="center"> |
| 13 | + <a href="https://beikeshop.com/" target="_blank"><img src="https://img.shields.io/badge/BeikeShop-%23FF6F30" alt="logo"></a> |
| 14 | + <a href="https://www.php.net/" target="_blank"><img src="https://img.shields.io/badge/PHP-8.3%2B-%234F5B93?logoColor=%234F5B93&labelColor=%234F5B93" alt="logo"></a> |
| 15 | + <a href="https://laravel.com/" target="_blank"><img src="https://img.shields.io/badge/-Laravel%2010-%23FF2D20?logo=laravel&logoColor=%23fff&labelColor=%23FF7467" alt="logo"></a> |
| 16 | +</div> |
| 17 | +<p align="center"> |
| 18 | + <a href="https://beikeshop.com/download" target="_blank"><img src="https://img.shields.io/badge/release-v1.5.6-%234B79B6?labelColor=%234B79B6" alt="logo"></a> |
| 19 | + <a href="https://beikeshop.com/demo" target="_blank"><img src="https://img.shields.io/badge/Demo-available-%2363B95C?labelColor=%23959494" alt="logo"></a> |
| 20 | + <a href="https://beikeshop.com/download" target="_blank"><img src="https://img.shields.io/badge/Downloads-163k-%23ED9017?logoColor=%23fff&labelColor=%23c57e37" alt="logo"></a> |
| 21 | +</p> |
| 22 | + |
| 23 | +<p align="center"> |
| 24 | + <u><a href="README.md">English</a></u> | |
| 25 | + <span>简体中文</span> |
| 26 | +</p> |
| 27 | + |
| 28 | +**Introduction to BeikeShop** |
| 29 | +BeikeShop is a globally leading open-source e-commerce Platform based on the Laravel framework, designed for the international trade and cross-border e-commerce industry. |
| 30 | +The System is 100% open-source! It supports a wide range of practical features, including multi-language, multi-currency, payment, logistics, and member management, making it easy for foreign trade businesses to expand their independent online stores. |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +# Framework |
| 35 | + |
| 36 | +- **Programming Language**: PHP 8.3 |
| 37 | +- **Framework**: Laravel 10 |
| 38 | +- **Frontend**: Blade Template + Vue.js |
| 39 | + |
| 40 | +--- |
| 41 | +# Live Demo |
| 42 | + |
| 43 | +Frontend Demo：[https://demo.beikeshop.com/](https://demo.beikeshop.com/) |
| 44 | + |
| 45 | +Backend Demo：[https://demo.beikeshop.com/admin/](https://demo.beikeshop.com/admin/login?admin_email=demo@beikeshop.com&admin_password=demo) |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +# Quick start |
| 50 | + |
| 51 | +**Ⅰ. Package Installation** |
| 52 | +1. <a href="https://beikeshop.com/download" target="_blank">Download BeikeShop</a> |
| 53 | +2. Upload to your server and unzip. |
| 54 | +3. Set the `public` folder as the website root directory. |
| 55 | +4. Access the website through your browser and follow the installation prompts. |
| 56 | +5. <a href="https://docs.beikeshop.com/en/install/bt.html" target="_blank">BeikeShop Detailed Installation Guide</a> |
| 57 | +6. If upgrading, download the latest version and overwrite on the server (make sure to keep the original `.env` file). Then, run `php artisan migrate` in the root directory. |
| 58 | + |
| 59 | +**Ⅱ. Source Code Installation** |
| 60 | +1. Open the command line and clone the repository: |
| 61 | + `git clone https://github.com/beikeshop/beikeshop.git` |
| 62 | +2. Enter the BeikeShop directory and run `composer install` to install third-party packages. |
| 63 | +3. Run `cp .env.example .env` to create the configuration file. |
| 64 | +4. Run `npm install` (Node version 16+ required), followed by `npm run prod` to compile frontend JS and CSS files. |
| 65 | +5. Set the `public` folder as the website root directory. |
| 66 | +6. Access the website through your browser and follow the installation prompts. |
| 67 | +7. For upgrades, run: |
| 68 | + `git pull && composer install && php artisan migrate` in the root directory. |
| 69 | + |
| 70 | +**Ⅲ. Docker Installation** |
| 71 | +1. Install Docker and Compose locally or on the server, refer to the installation guide here: [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) |
| 72 | +2. Execute the command: `git clone git@gitee.com:beikeshop/docker.git` |
| 73 | +3. Create a new directory named `www` as the website directory: `mkdir www`（See details: [https://docs.beikeshop.com/en/install/docker.html](https://docs.beikeshop.com/en/install/docker.html)） |
| 74 | +4. Enter the `docker` directory and create the configuration file based on the template: `cp env.example .env` |
| 75 | +5. Modify the `.env` file and `docker-compose` as needed, then run the command: `docker compose up -d` |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +# Environment Requirements |
| 80 | + |
| 81 | +- **Independent Server** (Virtual hosting not supported) |
| 82 | +- **CentOS 7.0+** or **Ubuntu 20.04+** |
| 83 | +- **PHP 8.3+** |
| 84 | +- **MySQL 5.7+** |
| 85 | +- **Apache httpd 2.4+** or **Nginx 1.10+** |
| 86 | + |
| 87 | +**Required PHP Extensions**: |
| 88 | +- BCMath |
| 89 | +- Ctype |
| 90 | +- cURL |
| 91 | +- DOM |
| 92 | +- Fileinfo |
| 93 | +- JSON |
| 94 | +- Mbstring |
| 95 | +- OpenSSL |
| 96 | +- PCRE |
| 97 | +- PDO |
| 98 | +- Tokenizer |
| 99 | +- XML |
| 100 | +--- |
| 101 | + |
| 102 | +# Key Features |
| 103 | + |
| 104 | +- **Zero Start-Up Cost**: BeikeShop is a true independent platform, 100% open-source, with 100% control over data. |
| 105 | +- **Built on Laravel 10**: Developed using the Laravel 10 framework, offering solid framework support. |
| 106 | +- **No Commission or Fees**: BeikeShop has no commissions, annual fees, or transaction fees, reducing the cost of setting up a website. |
| 107 | +- **Microkernel & Modular Design**: With a microkernel architecture and modular design, BeikeShop is easy to maintain and extend. |
| 108 | +- **Clear Code Structure & Format**: The system adopts a clear layered code structure with standardized formatting, improving readability and maintainability. |
| 109 | +- **Event System for Hook Functionality**: Flexible hook functionality is achieved through the event system, making customization and extension easier. |
| 110 | +- **Rich Plugin Marketplace**: A wide range of plugins are available in the official marketplace, allowing easy acquisition of required features. |
| 111 | +- **Multi-language and Multi-currency Support**: The system supports multiple languages and currencies, making it ideal for users across different regions and countries. |
| 112 | +- **Attractive Interface & Visual Customization**: BeikeShop features an attractive design with visual customization options, ensuring an excellent user experience. |
| 113 | +- **Strict MVC Architecture**: The system strictly follows the MVC architecture, enhancing maintainability and scalability. |
| 114 | +- **Easy Operation & Quick Setup**: BeikeShop is easy to operate and set up, allowing rapid deployment. |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | +--- |
| 119 | + |
| 120 | +# Store Preview |
| 121 | +<p> |
| 122 | + <a href="https://demo.beikeshop.com/" target="_blank" style="border: 1px solid #eee; display: inline-block;"> |
| 123 | + <img src="https://raw.githubusercontent.com/beikeshop/beikeshop-resource/refs/heads/master/img/demo.gif" style="width: 120%;"> |
| 124 | +</a> |
| 125 | +</p> |
| 126 | + |
| 127 | +# Page Previews |
| 128 | + |
| 129 | +1. **DIY Store Customization** |
| 130 | + |
| 131 | + <video src="https://github.com/user-attachments/assets/22c646ec-696e-4e33-ab26-545f0ee96ee5" controls="controls" muted="muted" class="d-block rounded-bottom-2 border-top width-fit" width="100%"> |
| 132 | + </video> |
| 133 | + |
| 134 | +2. **Product Detail Page** |
| 135 | + |
| 136 | +3. **Admin Product List** |
| 137 | + |
| 138 | + |
| 139 | + |
| 140 | + |
| 141 | +--- |
| 142 | +# Contributing |
| 143 | + |
| 144 | +1. Fork this repository. |
| 145 | +2. Create a new `feature-xxx` branch. |
| 146 | +3. Submit your code changes. |
| 147 | +4. Create a Merge Request. |
| 148 | +--- |
| 149 | + |
| 150 | +# Special Thanks |
| 151 | + |
| 152 | +- **Plugin Developers**: Lu Chuan Youth, Lao Liu, Aegis, Te̶lon̶ Uncle, Olives, etc. |
| 153 | +- **PR Contributors**: nilsir, what_village_head, tanxiaoyong, Lucky, So, licy, Lao Bei, Teemo, etc. |
| 154 | + |
| 155 | +We thank all contributors who participated in the development of BeikeShop, helping to make it better! |
| 156 | + |
| 157 | +--- |
| 158 | +**Note！** Please retain our company’s copyright information. Removal requires our company’s license authorization! |
0 commit comments