ChawkBazar Documentation
WelcomeTech We Have UsedGetting StartedInstallation VideoPrerequisitesGetting Started
Available Scripts & Command
How Can I use this app
Demo Deploy
Features
Settings
Payment
Shop Transfer
SEO and Analytics
API
Multilingual & Translation
OTP (Mobile Number Verification)Email ConfigurationEmail VerificationSocial LoginSubscribeFAQ PageContactTerms and conditions
Third-party Integrations
Deployment
Back-End Integration
Upgrade
Customizations
FAQSupportChangelogs

Getting Started

For getting started with the template you have to follow the below procedure. For quick guide you can check below videos for installation.

Installation Video

Please follow this video with the documentation, and it'll make the installation process on windows relatively easy.

Prerequisites

  • PHP 8.1

  • Composer

  • Xamp/Wamp/Lamp for any such application for apache, nginx, mysql

  • PHP plugins you must need

    • simplexml
    • PHP's dom extension
    • mbstring
    • GD Library

Frontend

  • node(20.0.0 or later, v20.9.0 much more appreciable)
  • yarn
  • editor: Visual Studio Code(recommended)

Getting Started

  1. First download the file from codecanyon.
  2. Unzip the downloaded file and folder structure you get
chawkbazar
|-- chawkbazar-api
|-- admin
|-- shop

  1. From the above folder structure you should notice that our app has three parts chawkbazar-api ,shop and admin. So you have to run all the parts separately and sequentially.

    Getting started with api

    • Make sure you have run xamp/mamp/wamp/lamp for mysql and php

    • Create a database in your mysql and put those info in next step

    • Rename .env.example file to .env and provide necessary credentials. Like database credentials stripe credentials, s3 credentials(only if you use s3 disk) admin email shop url etc. Specially check for this env variables

      DB_HOST=localhost
      DB_DATABASE=chawkbazar_laravel
      DB_USERNAME=root
      DB_PASSWORD=

    • Run composer install

      composer install

      composer success

    • run php artisan key:generate

      app key

    • Run php artisan marvel:install and follow necessary steps.

      chawkbazar install

    • For image upload to work properly you need to run php artisan storage:link.

    storage link

    • run php artisan serve

      server start

NB: your frontend NEXT_PUBLIC_REST_API_ENDPOINT env value will be localhost:8000/

For MAC and Linux(with sail and docker)

There is an alternate installation procedure for linux and mac. You can follow below procedure to getting started with sail

Prerequisites

  • Docker

    NB: Move chawkbazar-laravel folder from ChawkBazar Laravel - React, Next, REST API Ecommerce With Multivendor folder

Installation

Video

  • Run Docker application first
  • Now go to your chawkbazar-laravel root directory and run bash install.sh. It will guide you through some process. Follow those steps carefully and your app will be up and running
  • Navigate to api then sail down to stop the container. If you want to remove the volumes then sail down -v

NB: your frontend NEXT_PUBLIC_REST_API_ENDPOINT env value will be localhost/

For details api doc and requirements details you can go to Laravel API

Getting Started with Frontend

  1. After configuring API & running it successfully you can choose the directory where you need to work

Below are the directories where you will choose to work for frontend stuffs

cd admin/rest
cd shop

After choosing your working directory Go to specific folder and rename the .env.template => .env and put your api endpoint here. You will find .env.template file at the root of your admin/{chosen-directory-name} or shop

  1. Run yarn at the root directory.
# on chawkbazar/root directory
yarn

  1. Scripts To Run the fronted App

For Admin :

For starting the admin dashboard part with corresponding api data run below commands.

  • using workspace (At the root of the chawkbazar directory, you can run the below commands)
yarn dev:admin-rest

frontend script

  • without workspace(if you want to run the command within specific project root of admin/{chosen-directory-name})
# for dev mode run below command
# REST
yarn dev

This command will run the app in development mode. Open the suggested url in your terminal. like => http://localhost:3000 .

Note:

  • The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.
  • If you saw any error while running make Sure you setup your API endpoint properly at .env file.

For Shop :

Shop config

For starting the shop part with corresponding api data run below commands.

  • using workspace (At the root of the chawkbazar directory, you can run the below commands)
yarn dev:shop-rest

shop script

  • without workspace(if you want to run the command within specific project root of shop)
yarn dev

If you want to test your production build admin or shop in local environment then run the below commands.

Admin (At the root of the chawkbazar directory, you can run the below commands)

# build admin for production
yarn build:admin-rest


#start admin in production mode
yarn start:admin-rest

Shop (At the root of the chawkbazar directory, you can run the below commands)

# build shop for production
yarn build:shop-rest


# start shop in production mode
yarn start:shop-rest

build1 build2 start

Note : Please see package.json file for other builtin helper commands.

  1. For development purpose we use yarn workspace if you want to use it then see the package.json file at root, for various workspace specific command.
  • if you prefer single template then just copy the required template folder and separate them. you'll find their package.json file within them and follow the command for dev, build, start.
  1. For further development & customization check our Frontend Customization guide.