Skip to content

Commit

Permalink
[no-changelog][chore] update formatting and doc tagling
Browse files Browse the repository at this point in the history
  • Loading branch information
@jchip
jchip committed Apr 29, 2021
1 parent cb1eb80 commit 8630828
Show file tree
Hide file tree
Showing 18 changed files with 1,723 additions and 2,818 deletions.
1 change: 0 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -518,4 +518,3 @@ npm-debug.log*
yarn-debug.log*
yarn-error.log*
.fynpo

5 changes: 0 additions & 5 deletions .prettierrc
View file

This file was deleted.

4 changes: 2 additions & 2 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
<link rel="alternate" type="application/atom+xml" href="/electrode/blog/atom.xml" title="electrode OSS Blog Atom Feed"><title data-react-helmet="true">Page Not Found | electrode OSS</title><meta data-react-helmet="true" property="og:title" content="Page Not Found | electrode OSS"><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_tag" content="default"><link data-react-helmet="true" rel="shortcut icon" href="/electrode/img/electrode-logo.svg"><link rel="stylesheet" href="/electrode/styles.a1039d2a.css">
<link rel="preload" href="/electrode/styles.67ea3836.js" as="script">
<link rel="preload" href="/electrode/runtime~main.c0917e89.js" as="script">
<link rel="preload" href="/electrode/main.4514077a.js" as="script">
<link rel="preload" href="/electrode/main.c7eb565f.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 aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_2AAL">Skip to main content</button></nav><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 aria-label="Menu" 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="/electrode/"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--light_14oG navbar__logo"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--dark_18af navbar__logo"><strong class="navbar__title">electrode OSS</strong></a><a class="navbar__item navbar__link" href="/electrode/docs/getting-started">Getting Started</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/electrode-io/electrode/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_22nG"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_xh4A">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_xh4A">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/electrode/"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--light_14oG navbar__logo"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--dark_18af navbar__logo"><strong class="navbar__title">electrode OSS</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="/electrode/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a href="https://github.com/electrode-io/electrode/" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><footer class="footer footer--dark"><div class="container"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Walmart</div></div></div></footer></div>
<script src="/electrode/styles.67ea3836.js"></script>
<script src="/electrode/runtime~main.c0917e89.js"></script>
<script src="/electrode/main.4514077a.js"></script>
<script src="/electrode/main.c7eb565f.js"></script>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/docs/getting-started/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<link rel="alternate" type="application/atom+xml" href="/electrode/blog/atom.xml" title="electrode OSS Blog Atom Feed"><title data-react-helmet="true">Getting Started | electrode OSS</title><meta data-react-helmet="true" name="twitter:card" content="summary_large_image"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Getting Started | electrode OSS"><meta data-react-helmet="true" name="description" content="Web Applications with node.js and React"><meta data-react-helmet="true" property="og:description" content="Web Applications with node.js and React"><meta data-react-helmet="true" property="og:url" content="https://www.electrode.io/electrode/docs/getting-started"><link data-react-helmet="true" rel="shortcut icon" href="/electrode/img/electrode-logo.svg"><link data-react-helmet="true" rel="canonical" href="https://www.electrode.io/electrode/docs/getting-started"><link rel="stylesheet" href="/electrode/styles.a1039d2a.css">
<link rel="preload" href="/electrode/styles.67ea3836.js" as="script">
<link rel="preload" href="/electrode/runtime~main.c0917e89.js" as="script">
<link rel="preload" href="/electrode/main.4514077a.js" as="script">
<link rel="preload" href="/electrode/main.c7eb565f.js" as="script">
<link rel="preload" href="/electrode/common.dbfd37c1.js" as="script">
<link rel="preload" href="/electrode/11.b363ab4f.js" as="script">
<link rel="preload" href="/electrode/14.3cb725a5.js" as="script">
Expand All @@ -21,7 +21,7 @@
<nav aria-label="Skip navigation links"><button type="button" tabindex="0" class="skipToContent_2AAL">Skip to main content</button></nav><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 aria-label="Menu" 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="/electrode/"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--light_14oG navbar__logo"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--dark_18af navbar__logo"><strong class="navbar__title">electrode OSS</strong></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/electrode/docs/getting-started">Getting Started</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/electrode-io/electrode/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_22nG"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_xh4A">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_xh4A">🌞</span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a class="navbar__brand" href="/electrode/"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--light_14oG navbar__logo"><img src="/electrode/img/electrode-io-logo.png" alt="electrode logo" class="themedImage_2GZ8 themedImage--dark_18af navbar__logo"><strong class="navbar__title">electrode OSS</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/electrode/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a href="https://github.com/electrode-io/electrode/" target="_blank" rel="noopener noreferrer" class="menu__link">GitHub</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_2Eh5"><div class="docSidebarContainer_1P_d" role="complementary"><div class="sidebar_29t-"><div class="menu menu--responsive thin-scrollbar menu_3ZaZ"><button aria-label="Open Menu" aria-haspopup="true" class="button button--secondary button--sm menu__button" type="button"><svg aria-label="Menu" class="sidebarMenuIcon_NfO8" width="24" height="24" 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></button><ul class="menu__list"><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#!">Quick Start</a><ul class="menu__list"><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/electrode/docs/getting-started">Getting Started</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/electrode/docs/quick-start/the-packages">The Packages</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/electrode/docs/quick-start/the-application">The Application</a></li></ul></li></ul></div></div></div><main class="docMainContainer_ckOi"><div class="container padding-vert--lg docItemWrapper_cJVa"><div class="row"><div class="col docItemCol_2D4q"><div class="docItemContainer_2fhO"><article><header><h1 class="docTitle_3EdP">Getting Started</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_3oqq" id="web-applications-with-nodejs-and-react"></a>Web Applications with node.js and React<a class="hash-link" href="#web-applications-with-nodejs-and-react" title="Direct link to heading">#</a></h2><p>Welcome! This is the documentation for building web application using Electrode X for node.js and React.</p><p>In this quick start guide, we will show you how to create and run your first app.</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_3oqq" id="requirements"></a>Requirements<a class="hash-link" href="#requirements" title="Direct link to heading">#</a></h3><ol><li><p>Install <a href="https://nodejs.org/en/download" target="_blank" rel="noopener noreferrer">node.js</a> version 12.x.x or later</p><ul><li>For Unix or Windows, we recommend a <a href="https://www.npmjs.com/package/@jchip/nvm" target="_blank" rel="noopener noreferrer">universal node version manager</a> tool for managing node.js installations.</li><li>If you are using Unix only, then the Unix only <a href="https://github.com/nvm-sh/nvm#install-script" target="_blank" rel="noopener noreferrer">nvm</a> tool is a good option.</li></ul></li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_3oqq" id="creating-your-first-app"></a>Creating Your First App<a class="hash-link" href="#creating-your-first-app" title="Direct link to heading">#</a></h3><blockquote><p>Note: our packages are published under the npm scope <code>@xarc</code></p></blockquote><ol><li>To create your first Electrode X app:</li></ol><div class="mdxCodeBlock_1vfj"><div class="codeBlockContent_nlIh"><div tabindex="0" class="prism-code language-bash codeBlock_13t9 thin-scrollbar"><div class="codeBlockLines_ah8h" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">npx @xarc/create-app my-app</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2KNK">Copy</button></div></div><ol start="2"><li>Wait for this to complete. The console will display the following with some instructions:</li></ol><div class="mdxCodeBlock_1vfj"><div class="codeBlockContent_nlIh"><div tabindex="0" class="prism-code language-undefined codeBlock_13t9 thin-scrollbar"><div class="codeBlockLines_ah8h" style="color:#bfc7d5;background-color:#292d3e"><div class="token-line" style="color:#bfc7d5"><span class="token plain">Created react/node webapp in directory &#x27;my-app&#x27;. To start development, please run:</span></div></div></div><button type="button" aria-label="Copy code to clipboard" class="copyButton_2KNK">Copy</button></div></div><ol start="3"><li>Follow the instructions outlined in the console.</li><li>When complete, open your browser to <a href="http://localhost:3000" target="_blank" rel="noopener noreferrer">http://localhost:3000</a></li><li>To stop the DEV server, press <code>Q</code></li></ol><p>Your new electrode app will appear as shown below.</p><p><img alt="Hello from Electrode" src="/electrode/assets/images/first-app-c6e56f6df4cf4da1dc03cf1022053f66.png"></p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_3oqq" id="license"></a>License<a class="hash-link" href="#license" title="Direct link to heading">#</a></h2><p>Copyright (c) 2016-present, Walmart</p><p>Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="noopener noreferrer">Apache License, Version 2.0</a></p></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/electrode-io/electrode/tree/master/docusaurus/docs/docs/getting-started.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" role="img" viewBox="0 0 40 40" class="iconEdit_2lUs"><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"><a class="pagination-nav__link" href="/electrode/docs/quick-start/the-packages"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">The Packages »</div></a></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_2fJb thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#web-applications-with-nodejs-and-react" class="table-of-contents__link">Web Applications with node.js and React</a><ul><li><a href="#requirements" class="table-of-contents__link">Requirements</a></li><li><a href="#creating-your-first-app" class="table-of-contents__link">Creating Your First App</a></li></ul></li><li><a href="#license" class="table-of-contents__link">License</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2021 Walmart</div></div></div></footer></div>
<script src="/electrode/styles.67ea3836.js"></script>
<script src="/electrode/runtime~main.c0917e89.js"></script>
<script src="/electrode/main.4514077a.js"></script>
<script src="/electrode/main.c7eb565f.js"></script>
<script src="/electrode/common.dbfd37c1.js"></script>
<script src="/electrode/11.b363ab4f.js"></script>
<script src="/electrode/14.3cb725a5.js"></script>
Expand Down
Loading

0 comments on commit 8630828

Please sign in to comment.