Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 4.53 KB

README.md

File metadata and controls

114 lines (83 loc) · 4.53 KB
Raw

Throughput Graph

PRs Welcome Gitter

Apla-front

This project was bootstrapped with Create React App. You will find most of the information of how to use it there.

Installation

Project requires Node.js v6+ to run.

We use yarn as a package manager, so you will need to install yarn as well. Please refer to the instructions for your operating system.

Install the dependencies and devDependencies and start the server.

$ yarn install
$ yarn start

Start script will launch the development server which binds to http://127.0.0.1:7079 by default. You can also use start-desktop to debug the project in desktop environment

API binding can be customized to the value of your choice. Simply create a settings.json in your public directory. Example settings.json.dist is included in /public directory

Example configuration

{
    "defaultNetwork": "DEFAULT_NETWORK",
    "networks": [
        {
            "key": "DEFAULT_NETWORK",
            "name": "Default Network",
            "networkID": 100,
            "fullNodes": [
                "http://127.0.0.1:7079"
            ],
            "socketUrl": "",
            "activationEmail": "",
            "enableDemoMode": true,
            "disableSync": false
        }
    ]
}
  • defaultNetwork - Key of the default network that will be connected automatically
  • networks - Specifies an array of predefined network endpoints that are used to connect your application to the blockchain
  • networks[x].key - Specifies a unique key for a network
  • networks[x].name - A human readable network name that will be shown in the interface
  • networks[x].networkID - Unique identificator that is imprinted in all transactions. Refer to the configuration of your go-apla instance
  • networks[x].fullNodes - Prebuilt list of URLs that will be used for synchronization
  • networks[x].socketUrl - Optional parameter that overrides Centrifugo connection endpoint. Default: provided by go-apla configuration
  • networks[x].txViewerUrl - Optional parameter that is used to generate a link to transaction viewer. Receives {txhashes} template parameter and must not include a protocol scheme
  • networks[x].activationEmail - Optional parameter that will be shown to a user when there are no active endpoints to log in. Used for KYC
  • networks[x].enableDemoMode - When set to true, will enable authorization using the guest key
  • networks[x].disableSync - Optional parameter that disables synchronization of the full nodes. Unsafe, use with caution

Development server emits warnings and will report errors in readable format. You can hack around it, but it is suited only for development/testing. To use it in production environment you will need to build the project.

Build

Install the dependencies if you not did it already:

$ yarn install

Create your settings.json configuration file and build the project

Example

$ yarn build

After building, redistributable files will be placed to the '/build' directory. You can serve it with any web-server of your choice. Settings file must be also placed there

Building desktop application

Install the dependencies if you not did it already:

$ yarn install

Create your settings.json configuration file and build the project

Example

$ yarn build-desktop

When build process finishes you will need to package your application using "release". You will also need to specify "--publish never" so your project will not be published to github

Platforms can be specified with the combination of m/w/l arguments, where "m" stands for macOS, "w" for windows and "l" for linux

Example

$ yarn release --publish never -mwl

Will release desktop applications for macOS, windows and linux

Questions?

Feel free to contact us if you experience any kind of problems while using Apla: [email protected]