From 31809ec8cc772482e54a3654907310519725d0eb Mon Sep 17 00:00:00 2001 From: YasinDehfuli Date: Thu, 18 Jul 2024 21:34:52 +0330 Subject: [PATCH] Update README.md --- README.md | 82 +++- resources/images/xshop-logo.svg | 675 ++++++++++++++++++++++++++++++++ 2 files changed, 749 insertions(+), 8 deletions(-) create mode 100644 resources/images/xshop-logo.svg diff --git a/README.md b/README.md index 3ae917d..97f5b9b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,71 @@ -# xShop2 +
+ xShop logo +
-## make xcontroller +# xShop/v2 + +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 + +## Access to xShop/v1 + +https://github.com/a1Gard/xshop.v1 + + +## Installation + +[!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 +composer install +php artisan migrate:fresh --seed +php artisan storage:link +php artisan key:generate +php artisan serv +``` + +[!NOTE] +Default admin email is : `admin@example.com` and default password is: `password` + +## Requirement + +- php 8.3.9 [ `php-gd`, `sqlite3`, `php-soap` ] +- mysql or mariadb +- composer + +## 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 +php artisan db:seed --class=UserSeeder +php artisan db:seed --class=SettingSeeder +nano .env # make APP_DEBUG false, APP_ENV production +php artisan storage:link +php key:generate +composer install --optimize-autoloader --no-dev +``` + +## make xController Controller with log and semi-automatic CURD with logs User [`model`] @@ -9,34 +74,35 @@ User [`model`] php artisan make:xcontroller User ``` - - -## make theme part +## make theme part Theme part usable in area PartName [`theme aprt name`] -segmentName [`group`, `category`, `preloader`, ...], +segmentName [`group`, `category`, `preloader`, ...], ```bash php artisan make:part PartName segmentName ``` -## client optimize +## client optimize + Optimize client assets, `scss`,`js`,`css` ```bash php artisan client ``` + ### theme parts file - PartName.php: `onCreate`, `onRemove`, `onMount` actions of theme part -- PartName.blade.php: your theme part blade code +- 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 +### Screenshots

Developed With Love ! ❤️ diff --git a/resources/images/xshop-logo.svg b/resources/images/xshop-logo.svg new file mode 100644 index 0000000..5dd15b1 --- /dev/null +++ b/resources/images/xshop-logo.svg @@ -0,0 +1,675 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + +