Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BuyOwnEx committed Jun 9, 2021
1 parent 93fa4cc commit 31273a3
Showing 1 changed file with 75 additions and 21 deletions.
96 changes: 75 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
[main_screenshot]: https://demo.buyownex.com/main.jpg "Trading sreenshot"

# BOEClient

[![Build Status](https://img.shields.io/travis/buyownex/boeclient/master.svg)](https://travis-ci.org/buyownex/boeclient)
[![GitHub stars](https://img.shields.io/github/stars/buyownex/boeclient)](https://github.com/buyownex/boeclient/stargazers)
[![GitHub license](https://img.shields.io/github/license/buyownex/boeclient.svg)](https://raw.githubusercontent.com/buyownex/boeclient/master/LICENSE)

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)

![Trading sreenshot][main_screenshot]
Expand All @@ -9,46 +14,95 @@ BoeClient - b2b cryptocurrency exchange made on Laravel Framework. It`s allows y

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 status (deposit and withdrawal statuses)
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

# Installation
# Getting started

## Installation

Please check the official laravel 7.x installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/7.x/installation#installation)

Alternative installation is possible without local dependencies relying on [Docker](#docker).

Clone the repository

git clone [email protected]:buyownex/boeclient.git

Switch to the repo folder

cd boeclient

Install all the dependencies using composer

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

## Minimum server specifications
Create the symbolic link to the public storage

> 2.0 GHz 64-bit processor
php artisan storage:link

> 2Gb RAM
Start the local development server

> 32Gb SSD
php artisan serve

> 200Mb Internet Channel
You can now access the server at http://localhost

## Server requirements
**TL;DR command list**

> PHP >= 7.2.5
git clone [email protected]:buyownex/boeclient.git
cd boeclient
composer install
cp .env.example .env
php artisan key:generate

**Make sure you set the correct database connection information before running the migrations** [Environment variables](#environment-variables)

> BCMath PHP Extension
php artisan migrate
php artisan serve

## Docker

> Ctype PHP Extension
To install with [Docker](https://www.docker.com), run following commands:

> Fileinfo PHP extension
```
git clone [email protected]:buyownex/boeclient.git
cd boeclient
cp .env.example .env
docker run -v $(pwd):/app composer install
cd ./docker
docker-compose up -d
docker-compose exec php php artisan key:generate
docker-compose exec php php artisan migrate
docker-compose exec php php artisan storage:link
docker-compose exec php php artisan serve --host=0.0.0.0
```

> JSON PHP Extension
----------

> Mbstring PHP Extension
# Code overview

> OpenSSL PHP Extension
## Dependencies

> PDO PHP Extension
- [jwt-auth](https://github.com/tymondesigns/jwt-auth) - For authentication using JSON Web Tokens
- [laravel-cors](https://github.com/barryvdh/laravel-cors) - For handling Cross-Origin Resource Sharing (CORS)

> Tokenizer PHP Extension
## Environment variables

> XML PHP Extension
- `.env` - Environment variables can be set in this file

> MySQL 5.6+ || PostgreSQL 9.4+ || SQLite 3.8.8+ || SQL Server 2017+
***Note*** : You can quickly set the database information and other variables in this file and have the application fully working.

Do not forget to make storage link
```php artisan storage:link```

0 comments on commit 31273a3

Please sign in to comment.