Skip to content

Latest commit

 

History

History
225 lines (155 loc) · 7.66 KB

README.md

File metadata and controls

225 lines (155 loc) · 7.66 KB
Raw

Cryptocurrency Exchange Platform - Baseapp

Guide | API Docs | Consulting | Community

Component part of OpenDAX Trading Platform

OpenDAX BaseApp UI

User Interface for Trading and Wallets Management

React application to build a trading platform interface for use with OpenDAX: https://github.com/openware/opendax

You can see an example of a live application running at: https://www.openfinex.io/ If you need customization from the experts contact us: https://www.openware.com/

License

Please note, that BaseApp license only allows Non-Commercial use of this component. To purchase the Commercial license, please contact us at hello@openware.com.

Install dependencies

$ yarn install

Run in developement mode

$ yarn start-mock

This command will also start a fake api backend for helping development. Once you happy with the result, save, build an image and run it with OpenDAX docker compose system.

Execute tests

In <rootDir>

$ yarn test

Check test coverage:

$ yarn test -- --coverage --watchAll

For more options for jest run yarn test --help.

Configuration documentation

Configuration file is located in public/config/env.js

Argument                 Description                                                
api     URLs of barong, peatio, applogic and ranger API endpoints. You can use mockserver (https://github.com/openware/mockserver) with default env.js values
minutesUntilAutoLogout               Autologout time in minutes
withCredentials               false or true if you want to include cookies as part of the request(https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials)
gaTrackerKey Google Analytics tracker key
rangerReconnectPeriod Reconnection time for the Ranger WS service in minutes
msAlertDisplayTime  Alert message display duration in milliseconds
kycSteps  List of label names for KYC process

Available Docker build args

While building a Docker image you can pass build-dependant arguments using --build-arg: docker build -t baseapp:latest --build-arg BUILD_DOMAIN="example.com" .

Argument Description
BUILD_EXPIRE Unix Timestamp of the build expiration date in seconds
BUILD_DOMAIN Domain which you'd like to use during the deployment

Build mobile app

Install dependencies using npm. Important for mobile app development.

npm install

Build frontend

yarn build

Generate a native project (ios, android)

ionic capacitor add <platform>

To build a native app you should have Xcode or Android studio on your local machine.

Build IOS app

1. Install Xcode

Xcode is the IDE for creating native iOS apps. It includes the iOS SDK and Xcode command-line tools. Xcode can be downloaded for free with an Apple account or it can be installed through the App Store. Once Xcode is installed, make sure the command-line tools are selected for use:

xcode-select --install

2. Set up a development team

All iOS apps must be code signed, even for development. Luckily, Xcode makes this easy with automatic code signing. The only prerequisite is an Apple ID.

Open Xcode and navigate to Xcode » Preferences » Accounts. Add an Apple ID if none are listed. Once logged in, a Personal Team will appear in the team list of the Apple ID.

3. Create an iOS Simulator

You can test your mobile application with a connected Iphone device to the Mac or using IOS Simulator. Open Xcode and navigate to Window » Devices and Simulators. Create an iPhone 11 simulator if one does not already exist.

4. Set configs

Open the capacitor.config.json file and modify the appId property.

Put the name of BE server:

  "server": {
    "hostname": "example.openware.work"
  }

5. Open the project in Xcode.

Launch Xcode with a prepared app:

ionic capacitor run ios

6. Check Xcode configuration In Project navigator, select the project root to open the project editor. Under the Identity section, verify that the Package ID that was set matches the Bundle Identifier.

In the same project editor, under the Signing section, ensure Automatically manage signing is enabled. Then, select a Development Team. Given a Development Team, Xcode will attempt to automatically prepare provisioning and signing.

7. Update native app with the changes

With each meaningful change, Ionic apps must be built into web assets before the change can appear on iOS simulators and devices. The web assets then must be copied into the native project:

ionic capacitor copy ios

8. Build IOS app

To receive an executable app file run 'build' command on Xcode. You need to have an Apple Developer account to be able to extract an executable file from Xcode.

Build Android app

1. Install Android studio

Android Studio is IDE, that provides the fastest tools for building apps on every type of Android device.

2. Open the capacitor.config.json file and modify the linuxAndroidStudioPath property.

Run next command

whereis android-studio

3. Build your android application

ionic capacitor add android

4. Launch android application with Android Studio

ionic capacitor run android

5. Android Studio configuration

Select connected android device or configure device simulator, which required

6. Update app with the changes

ionic capacitor copy android [options]

7. Set ANDROID_SDK_ROOT variale

Set android ask path to ANDROID_SDK_ROOT or write sdk.dir variable in android/local.properties file (it doesn't exist as a default)

8. Build android app

Build android app using Android Studio Build tab

or you can build apk file with command line

Debug build:

  ionic capacitor copy android && cd android && ./gradlew assembleDebug && cd ..

Release build:

For release build you have to create keystore path and keystore alias and run next command:

  cd android &&
  ./gradlew assembleRelease &&
  cd app/build/outputs/apk/release &&
  jarsigner -keystore YOUR_KEYSTORE_PATH -storepass YOUR_KEYSTORE_PASS app-release-unsigned.apk YOUR_KEYSTORE_ALIAS &&
  zipalign 4 app-release-unsigned.apk app-release.apk

Happy trading with OpenDAX BaseApp UI

If you have designed something beautiful with it, we would love to see it!

And if you have any comments, feedback and suggestions - we are happy to hear from you here at GitHub or at https://openware.com

Licensing

This code is open for helping private modification and performing customer demonstration, you can use it for raising capital. You cannot use it for a live platform without getting a commercial license from us.

Contact us if you'd like to purchase a commercial license.

Partners

If you would like to fork, and modify this UI to create a BaseApp theme, we would be happy to setup a partnership program and sell your work provided a revenue sharing.

Made with love from Paris and Kiev.