nodeguy/docs/development/setting-up.md

Setup project for development

Development setup and getting started

Make sure you follow the setup guide of Qode so that you have a build environment ready for Qode.

MacOSX:

Requirements

1. Node version: > 9
2. Python and gcc
3. Make sure you dont have spaces inside your home path. NodeGYP has issues with spaces in the path. https://github.com/nodejs/node-gyp/issues/209
4. Qt (Optional): Make sure you followed the setup instructions from Qode

Windows:

Requirements

1. Node version: > 9
2. Python and Visual Studio Community 2017
3. Powershell
4. Qt (Optional): Make sure you followed the setup instructions from Qode

Linux:

Requirements

1. Node version: > 9
2. Python, Make, GCC, pkg-config
3. Qt (Optional): Make sure you followed the setup instructions from Qode

On Ubuntu: $ sudo apt-get install pkg-config build-essentials should install everything except Qt5.

Note: If you are using your own version of Qt make sure to

export PKG_CONFIG_PATH="<path to qt installation>/5.13.0/gcc_64/lib/pkgconfig"

Common:

1. Once you have setup the platform specific stuff as mentioned above, follow these:
2. git clone this repo.
3. yarn install
4. yarn build:addon
5. yarn dev

If you want to run with your own version of Qt make sure to pass qt_home_dir variable when building addon.

yarn rebuild:addon [--qt_home_dir=/path/to/qt]