Skip to content

Commit

Permalink
Add change log and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BuyOwnEx committed Nov 5, 2023
1 parent 950d4fa commit f6f8fb1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 103 deletions.
75 changes: 4 additions & 71 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,7 @@
# Release Notes

## [Unreleased](https://github.com/laravel/laravel/compare/v10.2.5...10.x)
## [v2.0.0](https://github.com/BuyOwnEx/BOEClient/compare/v2.0.0...v1.0.4) - 2023-11-05

## [v10.2.5](https://github.com/laravel/laravel/compare/v10.2.4...v10.2.5) - 2023-06-30

- Allow accessing APP_NAME in Vite scope by [@domnantas](https://github.com/domnantas) in https://github.com/laravel/laravel/pull/6204
- Omit default values for suffix in phpunit.xml by [@spawnia](https://github.com/spawnia) in https://github.com/laravel/laravel/pull/6210

## [v10.2.4](https://github.com/laravel/laravel/compare/v10.2.3...v10.2.4) - 2023-06-07

- Add `precognitive` key to $middlewareAliases by @emargareten in https://github.com/laravel/laravel/pull/6193

## [v10.2.3](https://github.com/laravel/laravel/compare/v10.2.2...v10.2.3) - 2023-06-01

- Update description by @taylorotwell in https://github.com/laravel/laravel/commit/85203d687ebba72b2805b89bba7d18dfae8f95c8

## [v10.2.2](https://github.com/laravel/laravel/compare/v10.2.1...v10.2.2) - 2023-05-23

- Add lock path by @taylorotwell in https://github.com/laravel/laravel/commit/a6bfbc7f90e33fd6cae3cb23f106c9689858c3b5

## [v10.2.1](https://github.com/laravel/laravel/compare/v10.2.0...v10.2.1) - 2023-05-12

- Add hashed cast to user password by @emargareten in https://github.com/laravel/laravel/pull/6171
- Bring back pusher cluster config option by @jesseleite in https://github.com/laravel/laravel/pull/6174

## [v10.2.0](https://github.com/laravel/laravel/compare/v10.1.1...v10.2.0) - 2023-05-05

- Update welcome.blade.php by @aymanatmeh in https://github.com/laravel/laravel/pull/6163
- Sets package.json type to module by @timacdonald in https://github.com/laravel/laravel/pull/6090
- Add url support for mail config by @chu121su12 in https://github.com/laravel/laravel/pull/6170

## [v10.1.1](https://github.com/laravel/laravel/compare/v10.0.7...v10.1.1) - 2023-04-18

- Fix laravel/framework constraints for Default Service Providers by @Jubeki in https://github.com/laravel/laravel/pull/6160

## [v10.0.7](https://github.com/laravel/laravel/compare/v10.1.0...v10.0.7) - 2023-04-14

- Adds `phpunit/[email protected]` support by @nunomaduro in https://github.com/laravel/laravel/pull/6155

## [v10.1.0](https://github.com/laravel/laravel/compare/v10.0.6...v10.1.0) - 2023-04-15

- Minor skeleton slimming by @taylorotwell in https://github.com/laravel/laravel/pull/6159

## [v10.0.6](https://github.com/laravel/laravel/compare/v10.0.5...v10.0.6) - 2023-04-05

- Add job batching options to Queue configuration file by @AnOlsen in https://github.com/laravel/laravel/pull/6149

## [v10.0.5](https://github.com/laravel/laravel/compare/v10.0.4...v10.0.5) - 2023-03-08

- Add replace_placeholders to log channels by @alanpoulain in https://github.com/laravel/laravel/pull/6139

## [v10.0.4](https://github.com/laravel/laravel/compare/v10.0.3...v10.0.4) - 2023-02-27

- Fix typo by @izzudin96 in https://github.com/laravel/laravel/pull/6128
- Specify facility in the syslog driver config by @nicolus in https://github.com/laravel/laravel/pull/6130

## [v10.0.3](https://github.com/laravel/laravel/compare/v10.0.2...v10.0.3) - 2023-02-21

- Remove redundant `@return` docblock in UserFactory by @datlechin in https://github.com/laravel/laravel/pull/6119
- Reverts change in asset helper by @timacdonald in https://github.com/laravel/laravel/pull/6122

## [v10.0.2](https://github.com/laravel/laravel/compare/v10.0.1...v10.0.2) - 2023-02-16

- Remove unneeded call by @taylorotwell in https://github.com/laravel/laravel/commit/3986d4c54041fd27af36f96cf11bd79ce7b1ee4e

## [v10.0.1](https://github.com/laravel/laravel/compare/v10.0.0...v10.0.1) - 2023-02-15

- Add PHPUnit result cache to gitignore by @itxshakil in https://github.com/laravel/laravel/pull/6105
- Allow php-http/discovery as a composer plugin by @nicolas-grekas in https://github.com/laravel/laravel/pull/6106

## [v10.0.0 (2022-02-14)](https://github.com/laravel/laravel/compare/v9.5.2...v10.0.0)

Laravel 10 includes a variety of changes to the application skeleton. Please consult the diff to see what's new.
- Support new version of Laravel Framework (v.10.x)
- Vite front end build tool instead of mix
- Support SPA version (see SPA_ENABLED param in .env file)
53 changes: 21 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In other parts this exchange do not differ from others and you will have all fun

## 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)
Please check the official laravel 10.x installation guide for server requirements before you start. [Official Documentation](https://laravel.com/docs/10.x/releases#support-policy)

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

Expand All @@ -35,13 +35,9 @@ Switch to the repo folder

cd boeclient

Install all the dependencies using composer v2 for PHP 7
Install all the dependencies using composer v2 for PHP 8

composer install

Install all the dependencies using composer v2 for PHP 8 with ignore flag of compatibility (due to incompatible of phpunit: phpunit/phpunit 8.5.9 requires php ^7.2)

composer install --ignore-platform-reqs

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

Expand All @@ -62,7 +58,7 @@ Create the symbolic link to the public storage
Make front-end build

npm install
npm run dev
npm run build

Start the local development server

Expand All @@ -77,28 +73,21 @@ You can now access the server at http://localhost:8000
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](#environment-variables)

php artisan migrate
php artisan serve

**Make sure you set the correct VITE_WS_SERVER before running front end build** [Environment variables](#environment-variables)

npm run build

## Docker

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

```
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
```
To install with [Docker](https://www.docker.com), you can use laradock infrastructure [Official Laradock Documentation](https://laradock.io/getting-started/)

----------

Expand All @@ -116,16 +105,21 @@ docker-compose exec php php artisan serve --host=0.0.0.0

Specific variables to this project:

# API Server, that handles incoming requests. Use this demo server for test purposes.
# 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

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

# Moble API keys
API_MOBILE_PUBLIC_KEY= // public key for mobile app (optional)
API_MOBILE_SECRET_KEY= // secret key for mobile app (optional)

# Choice between SPA application and common application
SPA_ENABLED=true

# When you navigate to the main page, redirection occurs to the http://localhost/trading/{DEFAULT_MARKET}/{DEFAULT_CURRENCY} link
DEFAULT_MARKET=USDT
DEFAULT_CURRENCY=BTC
Expand All @@ -147,10 +141,5 @@ Specific variables to this project:
GEETEST_ID=
GEETEST_KEY=

# verification driver choice. Possible values: local or sumsub
MIX_KYC_DRIVER=local
# payment for verification option: false - payment excluded, true - payment included
MIX_VERIFICATION_PAYMENT_REQUIRED=false

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

0 comments on commit f6f8fb1

Please sign in to comment.