mirror of https://github.com/4xmen/xshop.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
196 lines
4.5 KiB
Markdown
196 lines
4.5 KiB
Markdown
<div align="center">
|
|
<img width="250" src="resources/images/xshop-logo.svg" alt="xShop logo">
|
|
</div>
|
|
|
|
# xShop/v2
|
|
|
|
> [!NOTE]
|
|
> xShop is an open source shop developed in laravel, very customizable!
|
|
|
|
## New Features:
|
|
|
|
- Dashboard panel changes
|
|
- Integration of Vue.js and laravel
|
|
- Advanced charts
|
|
- Better customizable with AI & languages
|
|
- Fixed Technical issues
|
|
- Project size compression
|
|
- UI/UX is more specific
|
|
- Developer Friendlier
|
|
|
|
|
|
## Documentation
|
|
|
|
- [ 📄 **Full document** 📄 ](https://4xmen.github.io/xshop/#/)
|
|
- [🇮🇷 Persian read me](README-fa.md)
|
|
|
|
|
|
## Installation [ Development mode ]
|
|
|
|
> [!IMPORTANT]
|
|
> Create new database and rename `.env.example` to `.env` then update you `.env` configs so run this commands:
|
|
|
|
```bash
|
|
git clone https://github.com/4xmen/xshop.git
|
|
cd xshop
|
|
cp .env.example .env
|
|
composer install
|
|
php artisan migrate:fresh --seed
|
|
php artisan storage:link
|
|
php artisan key:generate
|
|
php artisan serv
|
|
|
|
# to develop front-end
|
|
npm i
|
|
php artisan client
|
|
npm install @rollup/rollup-win32-x64-msvc # just for windows if the below line dose not work
|
|
npm run dev
|
|
|
|
# or with yarn
|
|
|
|
yarn install
|
|
php artisan client
|
|
yarn add @rollup/rollup-win32-x64-msvc # just for windows if the below line dose not work
|
|
yarn dev
|
|
|
|
```
|
|
|
|
> [!TIP]
|
|
> Default admin email is : `developer@example.com` (developer) or `admin@example.com` (admin) and default password is: `password`
|
|
|
|
|
|
## image seeding
|
|
|
|
- Download & prepare images
|
|
```bash
|
|
php artisan seeding:prepare
|
|
```
|
|
- nor copy your image folder to `database/seeders/images/`
|
|
- then: Seeding image for models: [Group, Category, Post, Product, Slider]
|
|
|
|
```bash
|
|
php artisan seeding:image Product digital
|
|
```
|
|
|
|
Or to seed all models:
|
|
|
|
```bash
|
|
php artisan seeding:all digital
|
|
```
|
|
|
|
> First parameter is Model, Second is image seeder directory available [bag, clothe, digital, sport, posts, makeup]
|
|
> You can create your directory and put your image into new directory then use image seeder
|
|
|
|
## Requirement
|
|
|
|
- php 8.2.x or above [ `php-gd`, `sqlite3`, `php-soap`]
|
|
- mysql or mariadb or sqlite
|
|
- composer
|
|
- recommends install imagemagick on server to more image performance
|
|
|
|
## Deploy guide
|
|
|
|
We recommend deploy xShop on VPS, so create database and run this commands:
|
|
|
|
```bash
|
|
cd /home/[yourUsername]/[pathOfYourWebsitePublicHTML]
|
|
git clone https://github.com/4xmen/xshop.git . # if this command not work make empty this folder
|
|
cp .env.example .env
|
|
nano .env # edit your config db, url, etc.
|
|
composer install
|
|
php artisan migrate:fresh --seed
|
|
php artisan storage:link
|
|
php key:generate
|
|
npm install
|
|
php artisan client
|
|
npm run build
|
|
```
|
|
|
|
## Make your site optimize & production mode
|
|
|
|
|
|
```bash
|
|
nano .env # make APP_DEBUG false, APP_ENV production
|
|
php artisan optimize
|
|
composer install --optimize-autoloader --no-dev
|
|
```
|
|
|
|
## Add cron job
|
|
|
|
You must add crontab for your project:
|
|
|
|
```bash
|
|
crontab -e
|
|
```
|
|
|
|
Add this line:
|
|
```bash
|
|
* * * * * cd /home/[yourusername]/[your-public-html-project-root] && php artisan schedule:run >> /dev/null 2>&1
|
|
```
|
|
|
|
|
|
## make xController
|
|
|
|
Controller with log and semi-automatic CURD with logs
|
|
User [`model`]
|
|
|
|
```bash
|
|
php artisan make:xcontroller User
|
|
```
|
|
|
|
## make theme part
|
|
|
|
Theme part usable in area
|
|
|
|
PartName [`theme aprt name`]
|
|
|
|
segmentName [`group`, `category`, `preloader`, ...],
|
|
|
|
```bash
|
|
php artisan make:part PartName segmentName
|
|
```
|
|
|
|
## client optimize
|
|
|
|
Optimize client assets, `scss`,`js`,`css`
|
|
|
|
```bash
|
|
php artisan client
|
|
php artisan build
|
|
```
|
|
|
|
### theme parts file
|
|
|
|
- PartName.php: `onCreate`, `onRemove`, `onMount` actions of theme part
|
|
- PartName.blade.php: your theme part blade code
|
|
- PartName.scss: your theme part scss
|
|
- PartName.js: your theme part javascript
|
|
- screenshot.png: screenshot preview of theme part
|
|
|
|
## Demo
|
|
|
|
> Online demo available here: <a href="https://xshop.xstack.ir/login">https://xshop.xstack.ir/</a>
|
|
|
|
### Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Access to xShop/v1
|
|
> [!WARNING]
|
|
> xShop/v1 available here: <a href="https://github.com/4xmen/xshop.v1">https://github.com/4xmen/xshop.v1</a>
|
|
|
|
|
|
<p align="center">
|
|
Developed With Love ! ❤️
|
|
</p>
|