BOEClient

BoeClient - b2b cryptocurrency exchange made on Laravel Framework. It`s allows you to deploy your own crypto exchange in few minutes, but with some limitations (see below)

Limitations

This project not allow you to have full control on exchange, cause it is only web part of complex architecture. That is why you will have some limitations:

1. You can`t perform listing on your exchange
2. You have no control on currency deposit and withdrawal statuses
3. You have no direct access to crypto gateway

In other parts this exchange do not differ from others and you will have all functionality of normal exchange

Getting started

Installation

Please check the official laravel 10.x installation guide for server requirements before you start. Official Documentation

Alternative installation is possible without local dependencies relying on Docker.

Clone the repository

git clone git@github.com:buyownex/boeclient.git

Switch to the repo folder

cd boeclient

Install all the dependencies using composer v2 for PHP 8

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Create the symbolic link to the public storage

php artisan storage:link

Make front-end build

npm install
npm run build

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

TL;DR command list

git clone git@github.com:buyownex/boeclient.git
cd boeclient
composer install
cp .env.example .env
php artisan key:generate
php artisan storage:link
npm install

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Make sure you set the correct VITE_WS_SERVER before running front end build Environment variables

npm run build

Docker

To install with Docker, you can use laradock infrastructure Official Laradock Documentation

---

Code overview

Dependencies

• zendesk-laravel - For ticket system integration
• sanctum - For handling incoming API requests
• bacon-qr-code - For generating QR codes

Environment variables

.env - Environment variables can be set in this file

Specific variables to this project:

# Web socket server. Use this demo server for test purposes
VITE_WS_SERVER=wss://ws.buyownex.com/ws

# verification driver choice. Possible values: local or sumsub
VITE_KYC_DRIVER=local

# payment for verification option: false - payment excluded, true - payment included
VITE_VERIFICATION_PAYMENT_REQUIRED=false

# This name is displayed in several places on the site
VITE_CONFIG_APP_NAME=BuyOwnEx

# The version of BOEClient App
VITE_CONFIG_APP_VERSION="Trading module v.2.1.2"

# Your slogan. It is displayed in auth pages
VITE_CONFIG_SLOGAN="be the future. be the crypto"

# Depending on the type of product, different functionality is displayed. Possible values: "start", "startPlus", "full"
VITE_CONFIG_PRODUCT_TYPE=full

# Whether to display currencies at top menu
VITE_CONFIG_SHOW_CURRENCIES=false

# Copyright text
VITE_CONFIG_COPYRIGHT="Copyright © BuyOwnEx Ltd."

# Start of your activity
VITE_CONFIG_COPY_START_YEAR=2017

# Display this text after copyright
VITE_CONFIG_ALL_RIGHTS_TEXT="All rights reserved"

# Whether to use custom translate files instead of defaults. Custom files must be in custom directory nearby defaults files
VITE_CONFIG_USE_CUSTOM_TRANSLATE=false

# Choose the list of displayed languages
VITE_CONFIG_AVAILABLE_LOCALES=en,ru

# Default language
VITE_CONFIG_DEFAULT_LOCALE=en

# If translation not found, this language will be used
VITE_CONFIG_FALLBACK_LOCALE=en

# Icon type of user. Possible values: "initials", "identicon"
VITE_USER_ICON_TYPE=initials

# Icon type of API. Possible values: "initials", "identicon"
VITE_API_ICON_TYPE=identicon

# When you navigate to the main page, redirection occurs to the http://localhost/trading/{VITE_DEFAULT_MARKET}/{VITE_DEFAULT_CURRENCY} link
VITE_DEFAULT_MARKET=USDT
VITE_DEFAULT_CURRENCY=BTC

# API Server, that handles incoming requests. Use this demo server and API keys for test purposes
SERVER=https://api.buyownex.com
API_PUBLIC_KEY=9ayqB8BIUTyhDkEFxoNzyAVCQv523Fx9ynUhlHvOka7PUCOn91PMbh560wROb66Gu8rgm3gqoJkrbCgv // demo public key for SERVER
API_SECRET_KEY=q2e78LdPopmKPVCaAwxrrNmXb1qWMD3WoY77F7glTzByWD4d8zQHcyPLunBJ5I2szzzrbbsQGG141yeO // demo secret key for SERVER

# Choice between SPA application and common application
SPA_ENABLED=true

# Test server and credentials of KYC provider Sum&Substance. You can get own test account at https://sumsub.com/contact-us/
SUMSUB_SERVER=https://test-api.sumsub.com
SUMSUB_PUBLIC_KEY=
SUMSUB_SECRET_KEY=

# Zendesk credentials for ticket system. Get your own account at https://www.zendesk.com/register
ZENDESK_SUBDOMAIN=
ZENDESK_USERNAME=
ZENDESK_TOKEN=

# Is to use Captcha or not. It is recommended to use it. Disable it only if test purposes
CAPTCHA_ENABLED=true

# Captcha type. Available implementations: Geetest, CloudFlare
CAPTCHA_TYPE=Geetest

# Captcha ID and secret key. Get your own at official resources (https://www.geetest.com/en/ - Geetest; https://www.cloudflare.com/products/turnstile - CloudFlare)
CAPTCHA_ID=
CAPTCHA_SECRET=

Note : You can quickly set the database information and other variables in this file and have the application fully working.