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.
xshop/README.md

125 lines
2.9 KiB
Markdown

4 months ago
<div align="center">
<img width="250" src="resources/images/xshop-logo.svg" alt="xShop logo">
</div>
2 years ago
4 months ago
# xShop/v2
4 months ago
> [!NOTE]
> xShop is an open source shop developed in laravel, very customizable!
4 months ago
## 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
4 months ago
> [!WARNING]
> xShop/v1 available here: <a href="https://github.com/a1Gard/xshop.v1">https://github.com/a1Gard/xshop.v1</a>
4 months ago
## Installation
4 months ago
> [!IMPORTANT]
> Create new database and rename `.env.example` to `.env` then update you `.env` configs so run this commands:
4 months ago
```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
```
4 months ago
> [!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
```
- Seeding image for models: [Group, Category, Post, Product, Slider]
```bash
pa seeding:image Product 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
4 months ago
## 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
4 months ago
Controller with log and semi-automatic CURD with logs
User [`model`]
```bash
php artisan make:xcontroller User
```
4 months ago
## make theme part
4 months ago
Theme part usable in area
4 months ago
4 months ago
PartName [`theme aprt name`]
4 months ago
segmentName [`group`, `category`, `preloader`, ...],
4 months ago
```bash
php artisan make:part PartName segmentName
```
4 months ago
## client optimize
4 months ago
Optimize client assets, `scss`,`js`,`css`
4 months ago
```bash
php artisan client
```
4 months ago
4 months ago
### theme parts file
- PartName.php: `onCreate`, `onRemove`, `onMount` actions of theme part
4 months ago
- PartName.blade.php: your theme part blade code
4 months ago
- PartName.scss: your theme part scss
- PartName.js: your theme part javascript
- screenshot.png: screenshot preview of theme part
4 months ago
### Screenshots
4 months ago
<p align="center">
Developed With Love ! ❤️
</p>