psa-ax v0.0.1

Ax

Ax is a desktop tool, automating artistic production experience. This repo is created for developers. If you are searching for user manual, please access the wiki wiki

Get Start

Before you start, make sure you have node and yarn installed.

Install NodeJs

Run the following code in terminal / command for checking if you have installed node.

node -v

Follow this link to download and install node to your machine if you don't have node installed on your machine

Install Yarn

Instead of npm, Ax use Yarn as the package management tool.

Follow this link to download and install yarn to your machine

Initialise local project

After you clone the repo to local machine, run the following command:

yarn add electron --save-dev

This will install the newest electron module for you.

Try run the project

After you set up everything above, try the following command:

yarn test

This command will start Ax desktop in dev mode with a test panel.

There are other commands you can use:

yarn start - Start desktop app in normal mode.

Build the Desktop

The build system has updated to use yarn starting from v1.1.0.

Before you build the project, you should run the following command:

yarn add electron@latest

That will update the electron library to the newest version

To build the project, run the following command:

yarn dist

This will build the app based on the os environment. Built package/installer will be exported into _dist folder. You cannot build .app mac os app on windows, neither build .exe on mac.