Electron-based desktop app to manage and configure WPLib Box
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


WPLib Box

Electron-based desktop app to manage and configure WPLib Box

For running of the WPLib Box in to your environment, follow the steps below:

1. Download

With SSH:

$ git clone git@github.com:wplib/box-admin.git

or with HTTPS:

$ git clone https://github.com/wplib/box-admin.git

and then either the folder:

$ cd box-admin

2. Install Dependencies

To install the required dependencies with npm:

$ npm i

or with yarn:

$ yarn install

NOTE: To use the Box Admin application, you need to have the WPLib Box virtual machine running in your environment.

If you have already done this, skip to step 3.2

3. Install WPLib Box

Turn the following commands to install WPLib Box:


For install the Box, turn of the following the below steps:

3.1 Install the Box machine

Then enter the folder gearbox.local

$ cd src/renderer/box/gearbox.local/

And run the commands below in the terminal

$ vagrant up

NOTE: This is a process that may take a while and may vary from the environment and speed of your internet connection.

3.2 Running the Virtual Machine

To run the virtual machine, run the command below on the terminal in the gearbox.local folder:

$ cd src/renderer/box/gearbox.local/

Running the virtual machine:

$ vagrant up

3.3 Gearbox

3.3.1 Install Dependencies for Gearbox

To install the required dependencies, run the command below on the terminal in the spa folder:

$ cd src/renderer/box/gearbox.local/www/spa/

With npm:

$ npm i

Or with yarn:

$ yarn install

3.3.2 Build Assets

To build assets, run:

$ npm run build

3.3.3 Copy Static Files

For static files to be accessible through the url http://gearbox.local you need to copy the files generated after the build that are in src/renderer/box/gearbox.local/www/spa/dist to src/renderer/box/gearbox.local/www

For the next steps, you should go to the root of the box-admin project

4. Run Live With Hot Reload

Turn the following commands on the terminal to use project as a developer:

$ npm run dev

5. Build Setup

To generate the applications for the platform, run the following commands on the terminal according to your environment:

5.1 Build electron application for production MAC version

$ npm run build:mac

5.2 Build electron application for production Windows version

$ npm run build:windows

Run Unit Tests

# run unit & end-to-end tests
$ npm test
# lint all JS/Vue component files in `src/`
$ npm run lint