a1gard
/
xshop
mirror of https://github.com/4xmen/xshop.git
1
0
Fork 1
Code Issues 1 Packages Projects Releases Wiki Activity

Updated README file

Browse Source
pull/52/head
Keenan Bromley 3 days ago
parent 971143fa16
commit 4d71a5d690
1 changed files with 65 additions and 70 deletions
Show Stats Download Patch File Download Diff File

131
README.md
Unescape Escape View File

@ -1,3 +1,4 @@
<div align="center"> <div align="center">
<img width="250" src="resources/images/xshop-logo.svg" alt="xShop logo"> <img width="250" src="resources/images/xshop-logo.svg" alt="xShop logo">
</div> </div>
@ -5,31 +6,29 @@
# xShop/v2 # xShop/v2
> [!NOTE] > [!NOTE]
> xShop is an open source shop developed in laravel, very customizable! > xShop is an open-source shop developed in Laravel, highly customizable!
## New Features: ## New Features
- Dashboard panel changes - Dashboard panel improvements
- Integration of Vue.js and laravel - Integration of Vue.js and Laravel
- Advanced charts - Advanced charts
- Better customizable with AI & languages - Better customization with AI & language support
- Fixed Technical issues - Fixed technical issues
- Project size compression - Project size compression
- UI/UX is more specific - More specific UI/UX
- Developer Friendlier - Developer-friendly
- Custom theme design - Custom theme design
## Documentation ## Documentation
- [ 📄 **Full document** 📄 ](https://4xmen.github.io/xshop/#/) - [📄 **Full Documentation** 📄](https://4xmen.github.io/xshop/#/)
- [🇮🇷 Persian read me](README-fa.md) - [🇮🇷 Persian README](README-fa.md)
## Installation [Development Mode]
## Installation [ Development mode ]
> [!IMPORTANT] > [!IMPORTANT]
> Create new database and rename `.env.example` to `.env` then update you `.env` configs so run this commands: > Create a new database and rename `.env.example` to `.env`, then update your `.env` configurations. Run the following commands:
```bash ```bash
git clone https://github.com/4xmen/xshop.git git clone https://github.com/4xmen/xshop.git
@ -39,35 +38,34 @@ composer install
php artisan migrate:fresh --seed php artisan migrate:fresh --seed
php artisan storage:link php artisan storage:link
php artisan key:generate php artisan key:generate
php artisan serv php artisan serve
# to develop front-end # To develop front-end
npm i npm i
php artisan client php artisan client
npm install @rollup/rollup-win32-x64-msvc # just for windows if the below line dose not work npm install @rollup/rollup-win32-x64-msvc # Windows only, if the below line does not work
npm run dev npm run dev
# or with yarn # Or with yarn
yarn install yarn install
php artisan client php artisan client
yarn add @rollup/rollup-win32-x64-msvc # just for windows if the below line dose not work yarn add @rollup/rollup-win32-x64-msvc # Windows only, if the below line does not work
yarn dev yarn dev
``` ```
> [!TIP] > [!TIP]
> Default admin email is : `developer@example.com` (developer) or `admin@example.com` (admin) and default password is: `password` > Default admin emails are: `developer@example.com` (developer) or `admin@example.com` (admin)
> Default password: `password`
## Image Seeding
## image seeding - Download and prepare images:
- Download & prepare images
```bash ```bash
php artisan seeding:prepare php artisan seeding:prepare
``` ```
- nor copy your image folder to `database/seeders/images/` - Then copy your image folder to `database/seeders/images/`
- then: Seeding image for models: [Group, Category, Post, Product, Slider] - Seed images for models: [Group, Category, Post, Product, Slider]
```bash ```bash
php artisan seeding:image Product digital php artisan seeding:image Product digital
@ -79,94 +77,93 @@ Or to seed all models:
php artisan seeding:all digital php artisan seeding:all digital
``` ```
> First parameter is Model, Second is image seeder directory available [bag, clothe, digital, sport, posts, makeup] > The first parameter is the model name; the second is the image seeder directory. Available directories: `[bag, clothe, digital, sport, posts, makeup]`
> You can create your directory and put your image into new directory then use image seeder > You can create your own directory, add images to it, and use it with the image seeder.
## Requirement ## Requirements
- php 8.2.x or above [ `php-gd`, `sqlite3`, `php-soap`] - PHP 8.2.x or above with extensions: `php-gd`, `sqlite3`, `php-soap`
- mysql or mariadb or sqlite - MySQL, MariaDB, or SQLite
- composer - Composer
- recommends install imagemagick on server to more image performance - Recommended: Install ImageMagick on the server for better image performance
## Deploy guide ## Deployment Guide
We recommend deploy xShop on VPS, so create database and run this commands: We recommend deploying xShop on a VPS. Create a database and run the following commands:
```bash ```bash
cd /home/[yourUsername]/[pathOfYourWebsitePublicHTML] cd /home/[yourUsername]/[pathToYourWebsitePublicHTML]
git clone https://github.com/4xmen/xshop.git . # if this command not work make empty this folder git clone https://github.com/4xmen/xshop.git . # If this command doesn’t work, empty this folder first
cp .env.example .env cp .env.example .env
nano .env # edit your config db, url, etc. nano .env # Edit your DB config, URL, etc.
composer install composer install
php artisan migrate:fresh --seed php artisan migrate:fresh --seed
php artisan storage:link php artisan storage:link
php key:generate php artisan key:generate
npm install npm install
php artisan client php artisan client
npm run build npm run build
``` ```
## Make your site optimize & production mode ## Optimize for Production
```bash ```bash
nano .env # make APP_DEBUG false, APP_ENV production nano .env # Set APP_DEBUG=false, APP_ENV=production
php artisan optimize php artisan optimize
composer install --optimize-autoloader --no-dev composer install --optimize-autoloader --no-dev
``` ```
## Add cron job ## Add Cron Job
You must add crontab for your project: Add a crontab entry for your project:
```bash ```bash
crontab -e crontab -e
``` ```
Add this line: Add this line:
```bash ```bash
* * * * * cd /home/[yourusername]/[your-public-html-project-root] && php artisan schedule:run >> /dev/null 2>&1 * * * * * cd /home/[yourusername]/[your-public-html-project-root] && php artisan schedule:run >> /dev/null 2>&1
``` ```
## Create xController
## make xController Create a controller with logging and semi-automatic CRUD with logs.
Usage: [`model`]
Controller with log and semi-automatic CURD with logs
User [`model`]
```bash ```bash
php artisan make:xcontroller User php artisan make:xcontroller User
``` ```
## make theme part ## Create Theme Part
Theme part usable in area Create a reusable theme part in a specific area.
PartName [`theme aprt name`] Parameters:
PartName [`theme part name`]
segmentName [`group`, `category`, `preloader`, ...], segmentName [`group`, `category`, `preloader`, ...]
```bash ```bash
php artisan make:part PartName segmentName php artisan make:part PartName segmentName
``` ```
## client optimize ## Client Optimization
Optimize client assets, `scss`,`js`,`css` Optimize client assets: `scss`, `js`, `css`
```bash ```bash
php artisan client php artisan client
php artisan build php artisan build
``` ```
### theme parts file ### Theme Parts Files
- PartName.php: `onCreate`, `onRemove`, `onMount` actions of theme part - `PartName.php`: Contains `onCreate`, `onRemove`, `onMount` actions for the theme part
- PartName.blade.php: your theme part blade code - `PartName.blade.php`: Blade template for the theme part
- PartName.scss: your theme part scss - `PartName.scss`: SCSS styles for the theme part
- PartName.js: your theme part javascript - `PartName.js`: JavaScript for the theme part
- screenshot.png: screenshot preview of theme part - `screenshot.png`: Screenshot preview of the theme part
## Demo ## Demo
@ -184,13 +181,11 @@ php artisan build
![5](https://raw.githubusercontent.com/A1Gard/xshop-installer-assets/master/screenshots/xshop-screenshot5.jpg) ![5](https://raw.githubusercontent.com/A1Gard/xshop-installer-assets/master/screenshots/xshop-screenshot5.jpg)
## Access to xShop/v1 ## Access to xShop/v1
> [!WARNING]
> xShop/v1 available here: <a href="https://github.com/4xmen/xshop.v1">https://github.com/4xmen/xshop.v1</a>
> [!WARNING]
> xShop/v1 is available here: <a href="https://github.com/4xmen/xshop.v1">https://github.com/4xmen/xshop.v1</a>
<p align="center"> <p align="center">
Developed With Love ! ❤️ Developed with ❤️!
</p> </p>

Write Preview
Loading…
Cancel
Save