nodeguy/28c02e55.d8908ded.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[59],{151:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return i})),n.d(t,"rightToc",(function(){return l})),n.d(t,"metadata",(function(){return c})),n.d(t,"default",(function(){return u}));var a=n(1),o=n(6),r=(n(0),n(367)),i={},l=[{value:"Development setup and getting started",id:"development-setup-and-getting-started",children:[{value:"MacOSX:",id:"macosx",children:[]},{value:"Windows:",id:"windows",children:[]},{value:"Linux:",id:"linux",children:[]},{value:"Common:",id:"common",children:[]}]}],c={id:"development/setting-up",title:"setting-up",description:"# Setup project for development",source:"@site/docs/development/setting-up.md",permalink:"/docs/development/setting-up"},p={rightToc:l,metadata:c},b="wrapper";function u(e){var t=e.components,n=Object(o.a)(e,["components"]);return Object(r.b)(b,Object(a.a)({},p,n,{components:t,mdxType:"MDXLayout"}),Object(r.b)("h1",{id:"setup-project-for-development"},"Setup project for development"),Object(r.b)("h2",{id:"development-setup-and-getting-started"},"Development setup and getting started"),Object(r.b)("p",null,"Make sure you follow the setup guide of ",Object(r.b)("a",Object(a.a)({parentName:"p"},{href:"https://github.com/nodegui/qode"}),"Qode")," so that you have a build environment ready for Qode."),Object(r.b)("h3",{id:"macosx"},"MacOSX:"),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Requirements")),Object(r.b)("ol",null,Object(r.b)("li",{parentName:"ol"},"Node version: > 11"),Object(r.b)("li",{parentName:"ol"},"CMake 3.1 and up (Installation instructions can be found here: ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://cmake.org/install/"}),"https://cmake.org/install/"),")"),Object(r.b)("li",{parentName:"ol"},"Make, GCC v7"),Object(r.b)("li",{parentName:"ol"},"Qt (",Object(r.b)("em",{parentName:"li"},"Optional"),"): Make sure you followed the setup instructions from ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://github.com/nodegui/qode"}),"Qode"))),Object(r.b)("h3",{id:"windows"},"Windows:"),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Requirements")),Object(r.b)("ol",null,Object(r.b)("li",{parentName:"ol"},"Node version: > 11"),Object(r.b)("li",{parentName:"ol"},"CMake 3.1 and up (Installation instructions can be found here: ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://cmake.org/install/"}),"https://cmake.org/install/"),")"),Object(r.b)("li",{parentName:"ol"},"Visual Studio Community 2017"),Object(r.b)("li",{parentName:"ol"},"Powershell"),Object(r.b)("li",{parentName:"ol"},"Qt (",Object(r.b)("em",{parentName:"li"},"Optional"),"): Make sure you followed the setup instructions from ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://github.com/nodegui/qode"}),"Qode"))),Object(r.b)("h3",{id:"linux"},"Linux:"),Object(r.b)("p",null,"Supported versions: Ubuntu 17.10 and up"),Object(r.b)("p",null,Object(r.b)("strong",{parentName:"p"},"Requirements")),Object(r.b)("ol",null,Object(r.b)("li",{parentName:"ol"},"Node version: > 11"),Object(r.b)("li",{parentName:"ol"},"CMake 3.1 and up (Installation instructions can be found here: ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://cmake.org/install/"}),"https://cmake.org/install/"),")"),Object(r.b)("li",{parentName:"ol"},"Make, GCC v7, pkg-config"),Object(r.b)("li",{parentName:"ol"},"Qt (",Object(r.b)("em",{parentName:"li"},"Optional"),"): Make sure you followed the setup instructions from ",Object(r.b)("a",Object(a.a)({parentName:"li"},{href:"https://github.com/nodegui/qode"}),"Qode"))),Object(r.b)("p",null,"On Ubuntu: ",Object(r.b)("inlineCode",{parentName:"p"},"$ sudo apt-get install pkg-config build-essentials")," should install everything except Qt5."),Object(r.b)("p",null,"Note: If you are using your own version of Qt make sure to"),Object(r.b)("p",null,Object(r.b)("inlineCode",{parentName:"p"},'export PKG_CONFIG_PATH="<path to qt installation>/5.13.0/gcc_64/lib/pkgconfig"')),Object(r.b)("h3",{id:"common"},"Common:"),Object(r.b)("ol",null,Object(r.b)("li",{parentName:"ol"},"Once you have setup the platform specific stuff as mentioned above, follow these:"),Object(r.b)("li",{parentName:"ol"},Object(r.b)("inlineCode",{parentName:"li"},"git clone")," this repo."),Object(r.b)("li",{parentName:"ol"},Object(r.b)("inlineCode",{parentName:"li"},"yarn install")),Object(r.b)("li",{parentName:"ol"},Object(r.b)("inlineCode",{parentName:"li"},"yarn build:addon")),Object(r.b)("li",{parentName:"ol"},Object(r.b)("inlineCode",{parentName:"li"},"yarn dev"))),Object(r.b)("p",null,"If you want to run with your own version of Qt make sure to pass qt_home_dir variable when building addon."),Object(r.b)("p",null,Object(r.b)("inlineCode",{parentName:"p"},"npm run rebuild:addon [--qt_home_dir=/path/to/qt]")))}u.isMDXComponent=!0},367:function(e,t,n){"use strict";n.d(t,"a",(function(){return l})),n.d(t,"b",(function(){return u}));var a=n(0),o=n.n(a),r=o.a.createContext({}),i=function(e){var t=o.a.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):Object.assign({},t,e)),n},l=function(e){var t=i(e.components);return o.a.createElement(r.Provider,{value:t},e.children)};var c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},b=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,c=function(e,t){var n={};for(var a in e)Object.prototype.hasOwnProperty.call(e,a)&&-1===t.indexOf(a)&&(n[a]=e[a]);return n}(e,["components","mdxType","originalType","parentName"]),b=i(n),u=a,s=b[l+"."+u]||b[u]||p[u]||r;return n?o.a.createElement(s,Object.assign({},{ref:t},c,{components:n})):o.a.createElement(s,Object.assign({},{ref:t},c))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,i=new Array(r);i[0]=b;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:a,i[1]=l;for(var u=2;u<r;u++)i[u]=n[u];return o.a.createElement.apply(null,i)}return o.a.createElement.apply(null,n)}b.displayName="MDXCreateElement"}}]);