Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.11 KB

README.md

File metadata and controls

92 lines (61 loc) · 3.11 KB
Raw

Throughput Graph

PRs Welcome Build Status Gitter

Genesis-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

{
    "fullNodes": [
        "http://127.0.0.1:7079"
    ]
}

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 Genesis: [email protected]