43 lines
16 KiB
HTML
43 lines
16 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-alpha.64">
|
|
<link rel="preconnect" href="https://www.google-analytics.com">
|
|
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-145065218-1","auto"),ga("send","pageview")</script>
|
|
<script async src="https://www.google-analytics.com/analytics.js"></script>
|
|
<link rel="search" type="application/opensearchdescription+xml" title="NodeGui" href="/opensearch.xml"><title data-react-helmet="true">setting-up | NodeGui</title><meta data-react-helmet="true" name="docsearch:version" content="current,latest"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" property="og:title" content="setting-up | NodeGui"><meta data-react-helmet="true" name="description" content="Setup project for development"><meta data-react-helmet="true" property="og:description" content="Setup project for development"><meta data-react-helmet="true" property="og:url" content="https://nodegui.org/docs/development/setting-up"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.ico"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="true"><link data-react-helmet="true" rel="canonical" href="https://nodegui.org/docs/development/setting-up"><link rel="stylesheet" href="/styles.920797bd.css">
|
|
<link rel="preload" href="/styles.1b28431e.js" as="script">
|
|
<link rel="preload" href="/runtime~main.8f283571.js" as="script">
|
|
<link rel="preload" href="/main.c78546e3.js" as="script">
|
|
<link rel="preload" href="/1.386a6db3.js" as="script">
|
|
<link rel="preload" href="/2.2ece8892.js" as="script">
|
|
<link rel="preload" href="/3.8184ab2d.js" as="script">
|
|
<link rel="preload" href="/1be78505.afc94944.js" as="script">
|
|
<link rel="preload" href="/411.da87afc2.js" as="script">
|
|
<link rel="preload" href="/935f2afb.84f2e551.js" as="script">
|
|
<link rel="preload" href="/17896441.14a2377a.js" as="script">
|
|
<link rel="preload" href="/28c02e55.9253c53e.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
|
<nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a class="navbar__brand" href="/"><img class="navbar__logo" src="/img/logo-circle.png" alt="NodeGui Logo"><strong class="navbar__title">NodeGui</strong></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/docs/guides/getting-started">Docs</a><a class="navbar__item navbar__link" href="/docs/api/manual/synopsis">API</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a href="https://github.com/nodegui/nodegui" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_2aTZ"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_BsTx">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_BsTx">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span><span class="DocSearch-Button-Key">⌘</span><span class="DocSearch-Button-Key">K</span></button></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/"><img class="navbar__logo" src="/img/logo-circle.png" alt="NodeGui Logo"><strong class="navbar__title">NodeGui</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/guides/getting-started">Docs</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/api/manual/synopsis">API</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a href="https://github.com/nodegui/nodegui" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_2gpo"><main class="docMainContainer_3EyW"><div class="container padding-vert--lg docItemWrapper_1EkI"><div class="row"><div class="col docItemCol_2ASc"><div class="docItemContainer_3QWW"><article><header><h1 class="docTitle_1Lrw">setting-up</h1></header><div class="markdown"><h1><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="setup-project-for-development"></a>Setup project for development<a aria-hidden="true" tabindex="-1" class="hash-link" href="#setup-project-for-development" title="Direct link to heading">#</a></h1><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="development-setup-and-getting-started"></a>Development setup and getting started<a aria-hidden="true" tabindex="-1" class="hash-link" href="#development-setup-and-getting-started" title="Direct link to heading">#</a></h2><p>Make sure you follow the setup guide of <a href="https://github.com/nodegui/qode" target="_blank" rel="noopener noreferrer">Qode</a> so that you have a build environment ready for Qode.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="macosx"></a>MacOSX:<a aria-hidden="true" tabindex="-1" class="hash-link" href="#macosx" title="Direct link to heading">#</a></h3><p><strong>Requirements</strong></p><ol><li>Node version: > 11</li><li>CMake 3.1 and up (Installation instructions can be found here: <a href="https://cmake.org/install/" target="_blank" rel="noopener noreferrer">https://cmake.org/install/</a>)</li><li>Make, GCC v7</li><li>Qt (<em>Optional</em>): Make sure you followed the setup instructions from <a href="https://github.com/nodegui/qode" target="_blank" rel="noopener noreferrer">Qode</a></li></ol><p><strong><em>Only for M1 Macs</em></strong></p><p><strong><em>Setting up Qt:</em></strong></p><p>You will need to download and install Qt from source since there are no binaries from Qt for M1 yet. </p><p>(<a href="https://www.reddit.com/r/QtFramework/comments/ll58wg/how_to_build_qt_creator_for_macos_arm64_a_guide/" target="_blank" rel="noopener noreferrer">https://www.reddit.com/r/QtFramework/comments/ll58wg/how_to_build_qt_creator_for_macos_arm64_a_guide/</a>)</p><div class="mdxCodeBlock_1XEh"><div class="codeBlockContent_1u-d"><button type="button" aria-label="Copy code to clipboard" class="copyButton_10dd">Copy</button><div tabindex="0" class="prism-code language-undefined codeBlock_3iAC"><div class="codeBlockLines_b7E3" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">git clone git://code.qt.io/qt/qt5.git</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">cd qt5</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">git checkout 5.15</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">./init-repository --module-subset=essential -f</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">git submodule init qtsvg</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">git submodule update qtsvg</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">cd ..</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">mkdir qt5-5.15-macOS-release</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">cd qt5-5.15-macOS-release</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">../qt5/configure -release QMAKE_APPLE_DEVICE_ARCHS=arm64 -opensource -confirm-license -nomake examples -nomake tests -skip qt3d -skip webengine -skip qtactiveqt -skip qtcanvas3d -skip qtdeclarative -skip qtdatavis3d -skip qtdoc -skip qtgamepad -skip qtcharts -skip qtgraphicaleffects -skip qtlocation -skip qtpurchasing -skip qtquickcontrols -skip qtquickcontrols2 -skip qtremoteobjects -skip qtscxml -skip qtsensors -skip qtserialbus -skip qtserialport -skip qtspeech -skip qtvirtualkeyboard -skip qtscript</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">make -j15</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block">
|
|
</span></div><div class="token-line" style="color:#bfc7d5"><span class="token plain">make install</span></div></div></div></div></div><p>This should install Qt into something like this <code>/usr/local/Qt-5.15.3</code> (your directory can change. This will be displayed when running make)</p><p>Now just set <code>export QT_INSTALL_DIR=/usr/local/Qt-5.15.3</code> in either your .zshrc or .bashrc</p><p>Further steps would now use this custom Qt installation.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="windows"></a>Windows:<a aria-hidden="true" tabindex="-1" class="hash-link" href="#windows" title="Direct link to heading">#</a></h3><p><strong>Requirements</strong></p><ol><li>Node version: > 11</li><li>CMake 3.1 and up (Installation instructions can be found here: <a href="https://cmake.org/install/" target="_blank" rel="noopener noreferrer">https://cmake.org/install/</a>)</li><li>Visual Studio Community 2017</li><li>Powershell</li><li>Qt (<em>Optional</em>): Make sure you followed the setup instructions from <a href="https://github.com/nodegui/qode" target="_blank" rel="noopener noreferrer">Qode</a></li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="linux"></a>Linux:<a aria-hidden="true" tabindex="-1" class="hash-link" href="#linux" title="Direct link to heading">#</a></h3><p>Supported versions: Ubuntu 17.10 and up</p><p><strong>Requirements</strong></p><ol><li>Node version: > 11</li><li>CMake 3.1 and up (Installation instructions can be found here: <a href="https://cmake.org/install/" target="_blank" rel="noopener noreferrer">https://cmake.org/install/</a>)</li><li>Make, GCC v7, pkg-config</li><li>Qt (<em>Optional</em>): Make sure you followed the setup instructions from <a href="https://github.com/nodegui/qode" target="_blank" rel="noopener noreferrer">Qode</a></li></ol><p>On Ubuntu: <code>$ sudo apt-get install pkg-config build-essential</code> should install everything except Qt5.</p><p>Note: If you are using your own version of Qt make sure to</p><p><code>export PKG_CONFIG_PATH="<path to qt installation>/5.13.0/gcc_64/lib/pkgconfig"</code></p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2cZh" id="common"></a>Common:<a aria-hidden="true" tabindex="-1" class="hash-link" href="#common" title="Direct link to heading">#</a></h3><ol><li>Once you have setup the platform specific stuff as mentioned above, follow these:</li><li><code>git clone</code> this repo.</li><li><code>yarn install</code></li><li><code>yarn build:addon</code></li><li><code>yarn dev</code></li></ol><p>If you want to run with your own version of Qt make sure to pass qt_home_dir variable when building addon.</p><p><code>npm run rebuild:addon [--qt_home_dir=/path/to/qt]</code></p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/nodegui/nodegui/edit/master/website/docs/development/setting-up.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav" aria-label="Blog list page navigation"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_3SO_"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#development-setup-and-getting-started" class="table-of-contents__link">Development setup and getting started</a><ul><li><a href="#macosx" class="table-of-contents__link">MacOSX:</a></li><li><a href="#windows" class="table-of-contents__link">Windows:</a></li><li><a href="#linux" class="table-of-contents__link">Linux:</a></li><li><a href="#common" class="table-of-contents__link">Common:</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/guides/getting-started">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api/manual/synopsis">API</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a href="https://spectrum.chat/nodegui" target="_blank" rel="noopener noreferrer" class="footer__link-item">Spectrum</a></li><li class="footer__item"><a href="https://nodegui.slack.com" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack</a></li><li class="footer__item"><a href="https://twitter.com/node_gui" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a href="https://medium.com/nodegui" target="_blank" rel="noopener noreferrer" class="footer__link-item">Medium</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://react.nodegui.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">React NodeGui</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/faq">FAQ</a></li></ul></div></div><div class="text--center"><div>Copyright © 2022 NodeGui</div></div></div></footer></div>
|
|
<script src="/styles.1b28431e.js"></script>
|
|
<script src="/runtime~main.8f283571.js"></script>
|
|
<script src="/main.c78546e3.js"></script>
|
|
<script src="/1.386a6db3.js"></script>
|
|
<script src="/2.2ece8892.js"></script>
|
|
<script src="/3.8184ab2d.js"></script>
|
|
<script src="/1be78505.afc94944.js"></script>
|
|
<script src="/411.da87afc2.js"></script>
|
|
<script src="/935f2afb.84f2e551.js"></script>
|
|
<script src="/17896441.14a2377a.js"></script>
|
|
<script src="/28c02e55.9253c53e.js"></script>
|
|
</body>
|
|
</html> |