Quickstart

To run react project you will need couple thing to setup first, Install Node version v20.19.4(LTS). if you already not installed. download from Here

Project Configuration

After downloading the template, unzip it
Open the VS Code Terminal/System Terminal
Go to the folder (store): (cd path/to/template)
Run: npm install, it will install all used packages for this backend. If you see any vulnerability in packages run npm audit fix, it will fix/update all packages.
Make sure that there is no error.
Rename .env.example to .env

Cloudinary Configuration

Check this section for Cloudinary configuration, (We used Cloudinary for all image upload).

After configuration you .env.local file will look like this


VITE_APP_API_BASE_URL=http://localhost:5055/api
VITE_APP_STORE_DOMAIN=http://localhost:3000
VITE_APP_API_SOCKET_URL=http://localhost:5055


VITE_APP_CLOUD_NAME=your_cloudinary_cloud_name
VITE_APP_CLOUDINARY_API_KEY=your_cloudinary_api_key
VITE_APP_CLOUDINARY_API_SECRET=your_cloudinary_api_secret
VITE_APP_CLOUDINARY_UPLOAD_PRESET=your_cloudinary_upload_preset
VITE_APP_CLOUDINARY_URL=https://api.cloudinary.com/v1_1/your_cloudinary_cloud_name/image/upload


# for auto translation with my memory api key, this have limit but use this for upto free, you will 
# get the api key from here, just register and get the key for use https://mymemory.translated.net/doc/keygen.php
VITE_APP_MYMEMORY_API_KEY=your_my_memory_lang_api_key

# you must need to add this 32digit hex random key in both admin and backend same key, otherwish roles based will not work. 
# you can generate by this command, or use the bellow one as it is
# openssl rand -hex 32

VITE_APP_ENCRYPT_PASSWORD=856305f1a5b7ba87b8448e69b3bb7a4631c23f0afa2ca5331fa1373f7e372345

Running the Store

Now run npm run dev to start your store on the local server with PORT 4100 or the PORT you have specified.