flecks: NOT a fullstack framework
· 8 min read
diff --git a/404.html b/404.html index 99d75dbe..0d32f0b9 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
Flecks.priority
",id:"fleckspriority",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"ordering",children:"Ordering"}),"\n",(0,r.jsx)(n.p,{children:"Suppose we are composing an application and we have HTTP session state using cookies. When a\nuser hits a route, we need to load their session and subsequently read a value from said session\nto determine if the user prefers dark mode. Clearly, we will have to ensure that the session\nreification happens first. This is one function of orderable hooks."}),"\n",(0,r.jsxs)(n.p,{children:["Flecks uses the name of the hook as a configuration key in order to determine the ordering of a\nhook. Let's take a core hook as an example, ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"}),":"]}),"\n",(0,r.jsxs)(n.p,{children:["Our ",(0,r.jsx)(n.code,{children:"flecks.yml"})," could be configured like so:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"'@flecks/http/server':\n 'request.route':\n - '@flecks/session'\n - '@my-app/dark-mode-check'\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In this application, when ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"})," is invoked, ",(0,r.jsx)(n.code,{children:"@flecks/session"}),"'s\nimplementation is invoked (which reifies the user's session from cookies), followed by\n",(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"}),"'s."]}),"\n",(0,r.jsx)(n.h2,{id:"ellipseselision",children:"Ellipses/elision"}),"\n",(0,r.jsx)(n.p,{children:"It is not always ergonomic to configure the order of every single implementation, but enough to\nspecify which implementations must run first (or last)."}),"\n",(0,r.jsx)(n.p,{children:"For example, suppose we have multiple implementations that require there to have been a reified\nuser session, but which order those implementations run might not be a concern. For this, flecks\nprovides you with the ellipses entry:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"'@flecks/http/server':\n 'request.route':\n - '@flecks/session'\n - '...'\n - '@my-app/finalize'\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In this application, we first reify the user session as before, but instead of listing\n",(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"})," immediately after, we specify ellipses. After the ellipses we specify\n",(0,r.jsx)(n.code,{children:"@my-app/finalize"})," to do some finalization work."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"'...'"}),' essentially translates to: "every implementing fleck which has not already been explicitly\nlisted in the ordering configuration". The default ordering configuration for any orderable hook is: ',(0,r.jsx)(n.code,{children:"['...']"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Using more than one ellipses entry in an ordering configuration is ambiguous and will throw an\nerror."}),"\n",(0,r.jsx)(n.h2,{id:"fleckspriority",children:(0,r.jsx)(n.code,{children:"Flecks.priority"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"}),"'s implementation of ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"})," will always need\nto run after the user session server implementation runs. We can remove the need to configure\nthis manually by configuring the priority of our hook implementation."]}),"\n",(0,r.jsx)(n.p,{children:"If this is our dark mode checker:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:"export const hooks = {\n '@flecks/http/server.request.route': (flecks) => (req, res, next) => {\n if (req.session.prefersDarkMode) {\n // ...\n }\n },\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then this is the same implementation but configured to run after ",(0,r.jsx)(n.code,{children:"@flecks/session/server"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:"export const hooks = {\n '@flecks/http/server.request.route': Flecks.priority(\n (flecks) => (req, res, next) => {\n if (req.session.prefersDarkMode) {\n // ...\n }\n },\n {after: '@flecks/session/server'},\n ),\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var r=s(7294);const i={},o=r.createContext(i);function t(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/160a3b85.d5b6de3e.js b/assets/js/160a3b85.d5b6de3e.js
deleted file mode 100644
index c4532e41..00000000
--- a/assets/js/160a3b85.d5b6de3e.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[6128],{3987:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var r=s(5893),i=s(1151);const o={title:"Ordering",description:"Hint at and explicitly control the order in which things occur."},t="Ordering",c={id:"ordering",title:"Ordering",description:"Hint at and explicitly control the order in which things occur.",source:"@site/docs/ordering.mdx",sourceDirName:".",slug:"/ordering",permalink:"/flecks/docs/ordering",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"Ordering",description:"Hint at and explicitly control the order in which things occur."},sidebar:"flecksSidebar",previous:{title:"Gathering and Providing",permalink:"/flecks/docs/gathering"},next:{title:"Testing",permalink:"/flecks/docs/testing"}},l={},a=[{value:"Ellipses/elision",id:"ellipseselision",level:2},{value:"Flecks.priority
",id:"fleckspriority",level:2}];function d(e){const n={code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h1,{id:"ordering",children:"Ordering"}),"\n",(0,r.jsx)(n.p,{children:"Suppose we are composing an application and we have HTTP session state using cookies. When a\nuser hits a route, we need to load their session and subsequently read a value from said session\nto determine if the user prefers dark mode. Clearly, we will have to ensure that the session\nreification happens first. This is one function of orderable hooks."}),"\n",(0,r.jsxs)(n.p,{children:["Flecks uses the name of the hook as a configuration key in order to determine the ordering of a\nhook. Let's take a core hook as an example, ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"}),":"]}),"\n",(0,r.jsxs)(n.p,{children:["Our ",(0,r.jsx)(n.code,{children:"flecks.yml"})," could be configured like so:"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"'@flecks/http/server':\n 'request.route':\n - '@flecks/session'\n - '@my-app/dark-mode-check'\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In this application, when ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"})," is invoked, ",(0,r.jsx)(n.code,{children:"@flecks/session"}),"'s\nimplementation is invoked (which reifies the user's session from cookies), followed by\n",(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"}),"'s."]}),"\n",(0,r.jsx)(n.h2,{id:"ellipseselision",children:"Ellipses/elision"}),"\n",(0,r.jsx)(n.p,{children:"It is not always ergonomic to configure the order of every single implementation, but enough to\nspecify which implementations must run first (or last)."}),"\n",(0,r.jsx)(n.p,{children:"For example, suppose we have multiple implementations that require there to have been a reified\nuser session, but which order those implementations run might not be a concern. For this, flecks\nprovides you with the ellipses entry:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"'@flecks/http/server':\n 'request.route':\n - '@flecks/session'\n - '...'\n - '@my-app/finalize'\n"})}),"\n",(0,r.jsxs)(n.p,{children:["In this application, we first reify the user session as before, but instead of listing\n",(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"})," immediately after, we specify ellipses. After the ellipses we specify\n",(0,r.jsx)(n.code,{children:"@my-app/finalize"})," to do some finalization work."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"'...'"}),' essentially translates to: "every implementing fleck which has not already been explicitly\nlisted in the ordering configuration". The default ordering configuration for any orderable hook is: ',(0,r.jsx)(n.code,{children:"['...']"}),"."]}),"\n",(0,r.jsx)(n.p,{children:"Using more than one ellipses entry in an ordering configuration is ambiguous and will throw an\nerror."}),"\n",(0,r.jsx)(n.h2,{id:"fleckspriority",children:(0,r.jsx)(n.code,{children:"Flecks.priority"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"@my-app/dark-mode-check"}),"'s implementation of ",(0,r.jsx)(n.code,{children:"@flecks/http/server.request.route"})," will always need\nto run after the user session server implementation runs. We can remove the need to configure\nthis manually by configuring the priority of our hook implementation."]}),"\n",(0,r.jsx)(n.p,{children:"If this is our dark mode checker:"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:"export const hooks = {\n '@flecks/http/server.request.route': (flecks) => (req, res, next) => {\n if (req.session.prefersDarkMode) {\n // ...\n }\n },\n}\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Then this is the same implementation but configured to run after ",(0,r.jsx)(n.code,{children:"@flecks/session/server"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:"export const hooks = {\n '@flecks/http/server.request.route': Flecks.priority(\n (flecks) => (req, res, next) => {\n if (req.session.prefersDarkMode) {\n // ...\n }\n },\n {after: '@flecks/session/server'},\n ),\n}\n"})})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>c,a:()=>t});var r=s(7294);const i={},o=r.createContext(i);function t(e){const n=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),r.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1dc09441.6deebdb3.js b/assets/js/1dc09441.6deebdb3.js
deleted file mode 100644
index d5c2b98e..00000000
--- a/assets/js/1dc09441.6deebdb3.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[2528],{6711:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>c,toc:()=>d});var s=t(5893),i=t(1151);const r={title:"Testing",description:"Easily test your code across platforms."},a="Testing",c={id:"testing",title:"Testing",description:"Easily test your code across platforms.",source:"@site/docs/testing.mdx",sourceDirName:".",slug:"/testing",permalink:"/flecks/docs/testing",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"Testing",description:"Easily test your code across platforms."},sidebar:"flecksSidebar",previous:{title:"Ordering",permalink:"/flecks/docs/ordering"},next:{title:"Platforms",permalink:"/flecks/docs/platforms"}},o={},d=[];function l(e){const n={admonition:"admonition",code:"code",h1:"h1",img:"img",p:"p",pre:"pre",strong:"strong",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"testing",children:"Testing"}),"\n",(0,s.jsx)(n.p,{children:"flecks uses Mocha and Chai to run your tests."}),"\n",(0,s.jsx)(n.p,{children:"Let's create a small test application to illustrate how testing works in flecks:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"npx @flecks/create-app testing\n"})}),"\n",(0,s.jsx)(n.p,{children:"Move into your new project directory and create a fleck:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"npx @flecks/create-fleck unit\n"})}),"\n",(0,s.jsx)(n.p,{children:"You will notice a line in the output:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"No fleck tests found.\n"})}),"\n",(0,s.jsx)(n.p,{children:"flecks is trying to run the tests for the fleck, but none exist by default. Let's add some code\nand then add some tests to verify that it works."}),"\n",(0,s.jsxs)(n.p,{children:["Edit ",(0,s.jsx)(n.code,{children:"packages/unit/src/index.js"})," to add some code:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",metastring:'title="packages/unit/src/index.js"',children:"export const add2 = (n) => n + 2;\n\nexport const add3 = (n) => n + 3;\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Now create a ",(0,s.jsx)(n.code,{children:"packages/unit/test"})," directory and add a source file ",(0,s.jsx)(n.code,{children:"add2.js"})," inside:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",metastring:'title="packages/unit/test/add2.js"',children:"import {expect} from 'chai';\n\nconst {add2} = require('@testing/unit');\n\nit('can add two to a number', () => {\n // highlight-next-line\n expect(add2(2)).to.equal(5);\n});\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"We intentionally made an error so we can see what a failed test looks like."})}),"\n",(0,s.jsxs)(n.p,{children:["Now run the following command ",(0,s.jsxs)(n.strong,{children:["from within ",(0,s.jsx)(n.code,{children:"packages/unit"})]}),":"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run test\n"})}),"\n",(0,s.jsx)(n.p,{children:"You will see the following output:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" 1) can add two to a number\n\n 0 passing (11ms)\n 1 failing\n\n 1) can add two to a number:\n\n AssertionError: expected 4 to equal 5\n + expected - actual\n\n -4\n +5\n"})}),"\n",(0,s.jsx)(n.p,{children:"It caught the error! Let's fix it up:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",metastring:'title="packages/unit/test/add2.js"',children:"import {expect} from 'chai';\n\nconst {add2} = require('@testing/unit');\n\nit('can add two to a number', () => {\n // highlight-next-line\n expect(add2(2)).to.equal(4);\n});\n"})}),"\n",(0,s.jsx)(n.p,{children:"and try again:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run test\n"})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" \u2713 can add two to a number\n\n 1 passing (4ms)\n"})}),"\n",(0,s.jsx)(n.p,{children:"flecks also allows you to write tests that only target a specific platform. Let's add a webserver\nand then write a test that only runs for the client:"}),"\n",(0,s.jsx)(n.admonition,{type:"warning",children:(0,s.jsxs)(n.p,{children:["Make sure you run the following command in your ",(0,s.jsx)(n.strong,{children:"project directory"}),", not the ",(0,s.jsx)(n.code,{children:"packages/unit"}),"\ndirectory."]})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npx flecks add @flecks/web\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Now, let's add a test. We add a client test by adding a ",(0,s.jsx)(n.code,{children:"platforms/client"})," directory to our ",(0,s.jsx)(n.code,{children:"test"}),"\ndirectory and putting tests there:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",metastring:'title="packages/unit/test/platforms/client/add3.js"',children:"import {expect} from 'chai';\n\nconst {add3} = require('@testing/unit');\n\nit('can add three to a number', () => {\n // highlight-next-line\n expect(add3(2)).to.equal(6);\n});\n"})}),"\n",(0,s.jsx)(n.admonition,{type:"note",children:(0,s.jsx)(n.p,{children:"We intentionally made a mistake again to show a test failure."})}),"\n",(0,s.jsx)(n.p,{children:"Now start your application:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm start\n"})}),"\n",(0,s.jsx)(n.p,{children:"Visit your website in the browser and you will see:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"A screenshot of a browser showing the test runner page with our test failing",src:t(5408).Z+"",width:"1800",height:"1141"})}),"\n",(0,s.jsx)(n.p,{children:"The test is failing! That's what we expected."}),"\n",(0,s.jsx)(n.p,{children:"Now, edit your client test to fix it:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",metastring:'title="packages/unit/test/platforms/client/add3.js"',children:"import {expect} from 'chai';\n\nconst {add3} = require('@testing/unit');\n\nit('can add three to a number', () => {\n // highlight-next-line\n expect(add3(2)).to.equal(5);\n});\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Save the file. If you still have your application running, go look at the page. You'll notice that\n",(0,s.jsx)(n.strong,{children:"it updated automatically"})," to look like:"]}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.img,{alt:"A screenshot of a browser showing the test runner page with our test passing",src:t(5480).Z+"",width:"1833",height:"850"})}),"\n",(0,s.jsx)(n.p,{children:"Awesome, everything passes!"}),"\n",(0,s.jsxs)(n.admonition,{title:"Sanity check",type:"info",children:[(0,s.jsxs)(n.p,{children:["If you run ",(0,s.jsx)(n.code,{children:"npm run test"})," in your ",(0,s.jsx)(n.code,{children:"packages/unit"})," directory, you will see that only one test was\nrun:"]}),(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:" \u2713 can add two to a number\n\n 1 passing (3ms)\n"})}),(0,s.jsx)(n.p,{children:"That's correct; we only run client tests on the client."})]})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},5408:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/flecks-test-client-failed-49e983143a480c8c9d4923f33d085bb9.png"},5480:(e,n,t)=>{t.d(n,{Z:()=>s});const s=t.p+"assets/images/flecks-test-client-passed-8ca37755e8231280a12ef6a2240da94b.png"},1151:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>a});var s=t(7294);const i={},r=s.createContext(i);function a(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/935f2afb.aeb3b1db.js b/assets/js/935f2afb.aeb3b1db.js
deleted file mode 100644
index 15bf8b00..00000000
--- a/assets/js/935f2afb.aeb3b1db.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[53],{7676:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"flecksSidebar":[{"type":"link","label":"Introduction","href":"/flecks/docs/","docId":"introduction","unlisted":false},{"type":"category","label":"Getting Started","collapsed":false,"items":[{"type":"link","label":"Installation","href":"/flecks/docs/installation","docId":"installation","unlisted":false},{"type":"link","label":"Configuration","href":"/flecks/docs/configuration","docId":"configuration","unlisted":false},{"type":"link","label":"Creating a fleck","href":"/flecks/docs/creating-a-fleck","docId":"creating-a-fleck","unlisted":false},{"type":"link","label":"Building your application","href":"/flecks/docs/building-your-application","docId":"building-your-application","unlisted":false},{"type":"link","label":"Adding flecks","href":"/flecks/docs/adding-flecks","docId":"adding-flecks","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/getting-started"},{"type":"category","label":"Guides","collapsed":false,"items":[{"type":"category","label":"Writing your fleck(s)","collapsed":false,"items":[{"type":"link","label":"Building and testing your fleck","href":"/flecks/docs/building-your-fleck","docId":"building-your-fleck","unlisted":false},{"type":"link","label":"Hooks","href":"/flecks/docs/hooks","docId":"hooks","unlisted":false},{"type":"link","label":"Gathering and Providing","href":"/flecks/docs/gathering","docId":"gathering","unlisted":false},{"type":"link","label":"Ordering","href":"/flecks/docs/ordering","docId":"ordering","unlisted":false},{"type":"link","label":"Testing","href":"/flecks/docs/testing","docId":"testing","unlisted":false},{"type":"link","label":"Platforms","href":"/flecks/docs/platforms","docId":"platforms","unlisted":false},{"type":"link","label":"Documentation","href":"/flecks/docs/documentation","docId":"documentation","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/writing-your-flecks"},{"type":"link","label":"Command-line interface","href":"/flecks/docs/cli","docId":"cli","unlisted":false},{"type":"link","label":"Environment Variables","href":"/flecks/docs/environment","docId":"environment","unlisted":false},{"type":"link","label":"Database","href":"/flecks/docs/database","docId":"database","unlisted":false},{"type":"link","label":"Docker","href":"/flecks/docs/docker","docId":"docker","unlisted":false},{"type":"link","label":"Sockets","href":"/flecks/docs/sockets","docId":"sockets","unlisted":false},{"type":"link","label":"React","href":"/flecks/docs/react","docId":"react","unlisted":false},{"type":"link","label":"Electron","href":"/flecks/docs/electron","docId":"electron","unlisted":false},{"type":"link","label":"Redux","href":"/flecks/docs/redux","docId":"redux","unlisted":false},{"type":"link","label":"REPL","href":"/flecks/docs/repl","docId":"repl","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/guides"},{"type":"category","label":"Generated details","items":[{"type":"link","label":"Hooks","href":"/flecks/docs/flecks/hooks","docId":"flecks/hooks","unlisted":false},{"type":"link","label":"Fleck configuration","href":"/flecks/docs/flecks/config","docId":"flecks/config","unlisted":false},{"type":"link","label":"Build files","href":"/flecks/docs/flecks/build-files","docId":"flecks/build-files","unlisted":false},{"type":"link","label":"TODO list","href":"/flecks/docs/flecks/todos","docId":"flecks/todos","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/flecks/docs/category/generated-details"}]},"docs":{"adding-flecks":{"id":"adding-flecks","title":"Adding flecks","description":"Add flecks to your application to extend its functionality.","sidebar":"flecksSidebar"},"building-your-application":{"id":"building-your-application","title":"Building your application","description":"How your application is built.","sidebar":"flecksSidebar"},"building-your-fleck":{"id":"building-your-fleck","title":"Building and testing your fleck","description":"Learn how to build, test, and override defaults for your fleck","sidebar":"flecksSidebar"},"cli":{"id":"cli","title":"Command-line interface","description":"Use built-in commands and write your own.","sidebar":"flecksSidebar"},"configuration":{"id":"configuration","title":"Configuration","description":"Configure `build/flecks.yml` and your application.","sidebar":"flecksSidebar"},"creating-a-fleck":{"id":"creating-a-fleck","title":"Creating a fleck","description":"A fleck is a module but also so much more.","sidebar":"flecksSidebar"},"database":{"id":"database","title":"Database","description":"Define models and connect to a database.","sidebar":"flecksSidebar"},"docker":{"id":"docker","title":"Docker","description":"Spin up containers and orchestrate your production application.","sidebar":"flecksSidebar"},"documentation":{"id":"documentation","title":"Documentation","description":"Document your project.","sidebar":"flecksSidebar"},"electron":{"id":"electron","title":"Electron","description":"Run your application in Electron.","sidebar":"flecksSidebar"},"environment":{"id":"environment","title":"Environment Variables","description":"Configure your application with environment variables.","sidebar":"flecksSidebar"},"flecks/build-files":{"id":"flecks/build-files","title":"Build files","description":"All the build files in this project.","sidebar":"flecksSidebar"},"flecks/config":{"id":"flecks/config","title":"Fleck configuration","description":"All the configurable flecks in this project.","sidebar":"flecksSidebar"},"flecks/hooks":{"id":"flecks/hooks","title":"Hooks","description":"All the hooks in this project.","sidebar":"flecksSidebar"},"flecks/todos":{"id":"flecks/todos","title":"TODO list","description":"All the TODO items in this project.","sidebar":"flecksSidebar"},"gathering":{"id":"gathering","title":"Gathering and Providing","description":"Easily gather and provide things like database models, socket packets, etc.","sidebar":"flecksSidebar"},"hooks":{"id":"hooks","title":"Hooks","description":"The key to unlocking the power of flecks.","sidebar":"flecksSidebar"},"installation":{"id":"installation","title":"Installation","description":"How to get started with your first flecks project.","sidebar":"flecksSidebar"},"introduction":{"id":"introduction","title":"Introduction","description":"flecks makes a joy of JavaScript app development.","sidebar":"flecksSidebar"},"ordering":{"id":"ordering","title":"Ordering","description":"Hint at and explicitly control the order in which things occur.","sidebar":"flecksSidebar"},"platforms":{"id":"platforms","title":"Platforms","description":"It might matter where your code is running.","sidebar":"flecksSidebar"},"react":{"id":"react","title":"React","description":"Define root components, enable SSR, and more.","sidebar":"flecksSidebar"},"redux":{"id":"redux","title":"Redux","description":"Define your actions, reducers, and state.","sidebar":"flecksSidebar"},"repl":{"id":"repl","title":"REPL","description":"Start a REPL server and connect to it.","sidebar":"flecksSidebar"},"sockets":{"id":"sockets","title":"Sockets","description":"Run a websocket server and define packets.","sidebar":"flecksSidebar"},"testing":{"id":"testing","title":"Testing","description":"Easily test your code across platforms.","sidebar":"flecksSidebar"}}}')}}]);
\ No newline at end of file
diff --git a/assets/js/935f2afb.f9cb034c.js b/assets/js/935f2afb.f9cb034c.js
new file mode 100644
index 00000000..69296458
--- /dev/null
+++ b/assets/js/935f2afb.f9cb034c.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[53],{7676:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"flecksSidebar":[{"type":"link","label":"Introduction","href":"/flecks/docs/","docId":"introduction","unlisted":false},{"type":"category","label":"Getting Started","collapsed":false,"items":[{"type":"link","label":"Installation","href":"/flecks/docs/installation","docId":"installation","unlisted":false},{"type":"link","label":"Configuration","href":"/flecks/docs/configuration","docId":"configuration","unlisted":false},{"type":"link","label":"Creating a fleck","href":"/flecks/docs/creating-a-fleck","docId":"creating-a-fleck","unlisted":false},{"type":"link","label":"Building your application","href":"/flecks/docs/building-your-application","docId":"building-your-application","unlisted":false},{"type":"link","label":"Adding flecks","href":"/flecks/docs/adding-flecks","docId":"adding-flecks","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/getting-started"},{"type":"category","label":"Guides","collapsed":false,"items":[{"type":"category","label":"Writing your fleck(s)","collapsed":false,"items":[{"type":"link","label":"Building and testing your fleck","href":"/flecks/docs/building-your-fleck","docId":"building-your-fleck","unlisted":false},{"type":"link","label":"Hooks","href":"/flecks/docs/hooks","docId":"hooks","unlisted":false},{"type":"link","label":"Gathering and Providing","href":"/flecks/docs/gathering","docId":"gathering","unlisted":false},{"type":"link","label":"Ordering","href":"/flecks/docs/ordering","docId":"ordering","unlisted":false},{"type":"link","label":"Platforms","href":"/flecks/docs/platforms","docId":"platforms","unlisted":false},{"type":"link","label":"Documentation","href":"/flecks/docs/documentation","docId":"documentation","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/writing-your-flecks"},{"type":"link","label":"Command-line interface","href":"/flecks/docs/cli","docId":"cli","unlisted":false},{"type":"link","label":"Environment Variables","href":"/flecks/docs/environment","docId":"environment","unlisted":false},{"type":"link","label":"Database","href":"/flecks/docs/database","docId":"database","unlisted":false},{"type":"link","label":"Docker","href":"/flecks/docs/docker","docId":"docker","unlisted":false},{"type":"link","label":"Sockets","href":"/flecks/docs/sockets","docId":"sockets","unlisted":false},{"type":"link","label":"React","href":"/flecks/docs/react","docId":"react","unlisted":false},{"type":"link","label":"Electron","href":"/flecks/docs/electron","docId":"electron","unlisted":false},{"type":"link","label":"Redux","href":"/flecks/docs/redux","docId":"redux","unlisted":false},{"type":"link","label":"REPL","href":"/flecks/docs/repl","docId":"repl","unlisted":false}],"collapsible":true,"href":"/flecks/docs/category/guides"},{"type":"category","label":"Generated details","items":[{"type":"link","label":"Hooks","href":"/flecks/docs/flecks/hooks","docId":"flecks/hooks","unlisted":false},{"type":"link","label":"Fleck configuration","href":"/flecks/docs/flecks/config","docId":"flecks/config","unlisted":false},{"type":"link","label":"Build files","href":"/flecks/docs/flecks/build-files","docId":"flecks/build-files","unlisted":false},{"type":"link","label":"TODO list","href":"/flecks/docs/flecks/todos","docId":"flecks/todos","unlisted":false}],"collapsed":true,"collapsible":true,"href":"/flecks/docs/category/generated-details"}]},"docs":{"adding-flecks":{"id":"adding-flecks","title":"Adding flecks","description":"Add flecks to your application to extend its functionality.","sidebar":"flecksSidebar"},"building-your-application":{"id":"building-your-application","title":"Building your application","description":"How your application is built.","sidebar":"flecksSidebar"},"building-your-fleck":{"id":"building-your-fleck","title":"Building and testing your fleck","description":"Learn how to build, test, and override defaults for your fleck","sidebar":"flecksSidebar"},"cli":{"id":"cli","title":"Command-line interface","description":"Use built-in commands and write your own.","sidebar":"flecksSidebar"},"configuration":{"id":"configuration","title":"Configuration","description":"Configure `build/flecks.yml` and your application.","sidebar":"flecksSidebar"},"creating-a-fleck":{"id":"creating-a-fleck","title":"Creating a fleck","description":"A fleck is a module but also so much more.","sidebar":"flecksSidebar"},"database":{"id":"database","title":"Database","description":"Define models and connect to a database.","sidebar":"flecksSidebar"},"docker":{"id":"docker","title":"Docker","description":"Spin up containers and orchestrate your production application.","sidebar":"flecksSidebar"},"documentation":{"id":"documentation","title":"Documentation","description":"Document your project.","sidebar":"flecksSidebar"},"electron":{"id":"electron","title":"Electron","description":"Run your application in Electron.","sidebar":"flecksSidebar"},"environment":{"id":"environment","title":"Environment Variables","description":"Configure your application with environment variables.","sidebar":"flecksSidebar"},"flecks/build-files":{"id":"flecks/build-files","title":"Build files","description":"All the build files in this project.","sidebar":"flecksSidebar"},"flecks/config":{"id":"flecks/config","title":"Fleck configuration","description":"All the configurable flecks in this project.","sidebar":"flecksSidebar"},"flecks/hooks":{"id":"flecks/hooks","title":"Hooks","description":"All the hooks in this project.","sidebar":"flecksSidebar"},"flecks/todos":{"id":"flecks/todos","title":"TODO list","description":"All the TODO items in this project.","sidebar":"flecksSidebar"},"gathering":{"id":"gathering","title":"Gathering and Providing","description":"Easily gather and provide things like database models, socket packets, etc.","sidebar":"flecksSidebar"},"hooks":{"id":"hooks","title":"Hooks","description":"The key to unlocking the power of flecks.","sidebar":"flecksSidebar"},"installation":{"id":"installation","title":"Installation","description":"How to get started with your first flecks project.","sidebar":"flecksSidebar"},"introduction":{"id":"introduction","title":"Introduction","description":"flecks makes a joy of JavaScript app development.","sidebar":"flecksSidebar"},"ordering":{"id":"ordering","title":"Ordering","description":"Hint at and explicitly control the order in which things occur.","sidebar":"flecksSidebar"},"platforms":{"id":"platforms","title":"Platforms","description":"It might matter where your code is running.","sidebar":"flecksSidebar"},"react":{"id":"react","title":"React","description":"Define root components, enable SSR, and more.","sidebar":"flecksSidebar"},"redux":{"id":"redux","title":"Redux","description":"Define your actions, reducers, and state.","sidebar":"flecksSidebar"},"repl":{"id":"repl","title":"REPL","description":"Start a REPL server and connect to it.","sidebar":"flecksSidebar"},"sockets":{"id":"sockets","title":"Sockets","description":"Run a websocket server and define packets.","sidebar":"flecksSidebar"}}}')}}]);
\ No newline at end of file
diff --git a/assets/js/972d9d57.095085ef.js b/assets/js/972d9d57.095085ef.js
deleted file mode 100644
index 37b56f2e..00000000
--- a/assets/js/972d9d57.095085ef.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[937],{3134:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var i=s(5893),t=s(1151);const o={description:"flecks makes a joy of JavaScript app development.",slug:"/"},r="Introduction",l={id:"introduction",title:"Introduction",description:"flecks makes a joy of JavaScript app development.",source:"@site/docs/introduction.mdx",sourceDirName:".",slug:"/",permalink:"/flecks/docs/",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{description:"flecks makes a joy of JavaScript app development.",slug:"/"},sidebar:"flecksSidebar",next:{title:"Getting Started",permalink:"/flecks/docs/category/getting-started"}},a={},c=[{value:"Features",id:"features",level:2},{value:"Design principles",id:"design-principles",level:2},{value:"Staying informed",id:"staying-informed",level:2},{value:"Something missing?",id:"something-missing",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsxs)(n.p,{children:["\u26a1\ufe0f flecks will help you build a ",(0,i.jsx)(n.strong,{children:"flexible and powerful application in no time"}),"."]}),"\n",(0,i.jsxs)(n.p,{children:["\ud83d\udcb8 Save time and money and don't duplicate effort. Instead, ",(0,i.jsx)(n.strong,{children:"lean on infrastructure that already exists"})," to solve your problems."]}),"\n",(0,i.jsxs)(n.p,{children:["\ud83e\uddd0 flecks is an ",(0,i.jsx)(n.strong,{children:"exceptionally-extensible fullstack application production system"}),". Its true purpose\nis to make application development a more joyful endeavor. Intelligent defaults combined with\na highly dynamic structure motivate consistency while allowing you to easily express your own\narchitectural opinions."]}),"\n",(0,i.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,i.jsx)(n.p,{children:"flecks is built with supreme attention to the developer and end-user experience."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["\ud83e\udde9 ",(0,i.jsx)(n.strong,{children:"Small but pluggable"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The simplest application is two flecks, ",(0,i.jsx)(n.code,{children:"core"})," and ",(0,i.jsx)(n.code,{children:"server"})," (",(0,i.jsx)(n.strong,{children:"7 MB"})," production server size): you don't pay for what you don't buy"]}),"\n",(0,i.jsxs)(n.li,{children:["Endlessly configurable through built-in ",(0,i.jsx)(n.a,{href:"./docs/flecks/hooks",children:"hooks"})," and then your own"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\ud83d\udee0\ufe0f ",(0,i.jsx)(n.strong,{children:"Ready to build maintainable and performant production applications"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./docs/documentation",children:"Documentation"})," generation for your project with no fuss"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./docs/testing",children:"Write tests"}),", run on server/in browser/..."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./docs/react",children:"React"})," / ",(0,i.jsx)(n.a,{href:"./docs/redux",children:"redux"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./docs/sockets",children:"Realtime sockets"})," with lots of goodies like binary packing and packet dispatching"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./docs/database",children:"Databases"})," using ",(0,i.jsx)(n.a,{href:"https://sequelize.org/",children:"Sequelize"})," to connect and ",(0,i.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," to easily persist"]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"./docs/electron",children:"Electron"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"./docs/docker",children:"Docker"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"./docs/repl",children:"REPL"})}),"\n",(0,i.jsx)(n.li,{children:"babel + Webpack 5"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\ud83d\udc77 ",(0,i.jsx)(n.strong,{children:"Developers, developers, developers"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Easy to create a fleck; no need to publish packages or use voodoo"}),"\n",(0,i.jsx)(n.li,{children:"HMR (even on the server)"}),"\n",(0,i.jsx)(n.li,{children:"Configured to get instantly up and running with a consistent path toward production"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Our shared goal\u2014to help you quickly develop your application. We share our best practices to help you build your application right and well."}),"\n",(0,i.jsx)(n.h2,{id:"design-principles",children:"Design principles"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Little to learn"}),". flecks should be easy to learn and use as the API is quite small. Most things will still be achievable by users, even if it takes them more code and more time to write. Not having abstractions is better than having the wrong abstractions, and we don't want users to have to hack around the wrong abstractions. Mandatory talk\u2014",(0,i.jsx)(n.a,{href:"https://www.youtube.com/watch?v=4anAwXYqLG8",children:"Minimal API Surface Area"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Intuitive"}),". Users will not feel overwhelmed when looking at the project directory of a flecks project or adding new features. It should look intuitive and easy to build on top of, using approaches they are familiar with."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Modular"}),". flecks is built from the ground up with separation of concerns as a first-class concern."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Sensible defaults"}),". Common and popular performance optimizations and configurations will be done for users but they are given the option to override them. One should have to go out of their way in order to do the wrong thing."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"No vendor lock-in"}),". Users are not required to use the default flecks, although they are encouraged to."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Minimize duplicated effort"}),". For instance, we ripped a lot of this wording off of the Docusaurus introduction page. ","\ud83d\udc83"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"We believe that, as developers, knowing how something works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various aspects of flecks with the hope that users reading it will gain a deeper understanding and be even more proficient in using it."}),"\n",(0,i.jsx)(n.h2,{id:"staying-informed",children:"Staying informed"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"https://github.com/cha0s/flecks",children:"GitHub"})}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"something-missing",children:"Something missing?"}),"\n",(0,i.jsxs)(n.p,{children:["If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please ",(0,i.jsx)(n.a,{href:"https://github.com/cha0s/flecks/issues/new",children:"file an issue"})," for us."]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1151:(e,n,s)=>{s.d(n,{Z:()=>l,a:()=>r});var i=s(7294);const t={},o=i.createContext(t);function r(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/972d9d57.e94a6984.js b/assets/js/972d9d57.e94a6984.js
new file mode 100644
index 00000000..93d632ee
--- /dev/null
+++ b/assets/js/972d9d57.e94a6984.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[937],{3134:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>l,toc:()=>c});var s=i(5893),t=i(1151);const o={description:"flecks makes a joy of JavaScript app development.",slug:"/"},r="Introduction",l={id:"introduction",title:"Introduction",description:"flecks makes a joy of JavaScript app development.",source:"@site/docs/introduction.mdx",sourceDirName:".",slug:"/",permalink:"/flecks/docs/",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{description:"flecks makes a joy of JavaScript app development.",slug:"/"},sidebar:"flecksSidebar",next:{title:"Getting Started",permalink:"/flecks/docs/category/getting-started"}},a={},c=[{value:"Features",id:"features",level:2},{value:"Design principles",id:"design-principles",level:2},{value:"Staying informed",id:"staying-informed",level:2},{value:"Something missing?",id:"something-missing",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,t.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsxs)(n.p,{children:["\u26a1\ufe0f flecks will help you build a ",(0,s.jsx)(n.strong,{children:"flexible and powerful application in no time"}),"."]}),"\n",(0,s.jsxs)(n.p,{children:["\ud83d\udcb8 Save time and money and don't duplicate effort. Instead, ",(0,s.jsx)(n.strong,{children:"lean on infrastructure that already exists"})," to solve your problems."]}),"\n",(0,s.jsxs)(n.p,{children:["\ud83e\uddd0 flecks is an ",(0,s.jsx)(n.strong,{children:"exceptionally-extensible fullstack application production system"}),". Its true purpose\nis to make application development a more joyful endeavor. Intelligent defaults combined with\na highly dynamic structure motivate consistency while allowing you to easily express your own\narchitectural opinions."]}),"\n",(0,s.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,s.jsx)(n.p,{children:"flecks is built with supreme attention to the developer and end-user experience."}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\ud83e\udde9 ",(0,s.jsx)(n.strong,{children:"Small but pluggable"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["The simplest application is two flecks, ",(0,s.jsx)(n.code,{children:"core"})," and ",(0,s.jsx)(n.code,{children:"server"})," (",(0,s.jsx)(n.strong,{children:"7 MB"})," production server size): you don't pay for what you don't buy"]}),"\n",(0,s.jsxs)(n.li,{children:["Endlessly configurable through built-in ",(0,s.jsx)(n.a,{href:"./docs/flecks/hooks",children:"hooks"})," and then your own"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\ud83d\udee0\ufe0f ",(0,s.jsx)(n.strong,{children:"Ready to build maintainable and performant production applications"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"./docs/documentation",children:"Documentation"})," generation for your project with no fuss"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"./docs/building-your-fleck#testing",children:"Write tests"}),", run on server/in browser/..."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"./docs/react",children:"React"})," / ",(0,s.jsx)(n.a,{href:"./docs/redux",children:"redux"})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"./docs/sockets",children:"Realtime sockets"})," with lots of goodies like binary packing and packet dispatching"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"./docs/database",children:"Databases"})," using ",(0,s.jsx)(n.a,{href:"https://sequelize.org/",children:"Sequelize"})," to connect and ",(0,s.jsx)(n.a,{href:"https://www.docker.com/",children:"Docker"})," to easily persist"]}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"./docs/electron",children:"Electron"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"./docs/docker",children:"Docker"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"./docs/repl",children:"REPL"})}),"\n",(0,s.jsx)(n.li,{children:"babel + Webpack 5"}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\ud83d\udc77 ",(0,s.jsx)(n.strong,{children:"Developers, developers, developers"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Easy to create a fleck; no need to publish packages or use voodoo"}),"\n",(0,s.jsx)(n.li,{children:"HMR (even on the server)"}),"\n",(0,s.jsx)(n.li,{children:"Configured to get instantly up and running with a consistent path toward production"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Our shared goal\u2014to help you quickly develop your application. We share our best practices to help you build your application right and well."}),"\n",(0,s.jsx)(n.h2,{id:"design-principles",children:"Design principles"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Little to learn"}),". flecks should be easy to learn and use as the API is quite small. Most things will still be achievable by users, even if it takes them more code and more time to write. Not having abstractions is better than having the wrong abstractions, and we don't want users to have to hack around the wrong abstractions. Mandatory talk\u2014",(0,s.jsx)(n.a,{href:"https://www.youtube.com/watch?v=4anAwXYqLG8",children:"Minimal API Surface Area"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Intuitive"}),". Users will not feel overwhelmed when looking at the project directory of a flecks project or adding new features. It should look intuitive and easy to build on top of, using approaches they are familiar with."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Modular"}),". flecks is built from the ground up with separation of concerns as a first-class concern."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Sensible defaults"}),". Common and popular performance optimizations and configurations will be done for users but they are given the option to override them. One should have to go out of their way in order to do the wrong thing."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"No vendor lock-in"}),". Users are not required to use the default flecks, although they are encouraged to."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:"Minimize duplicated effort"}),". For instance, we ripped a lot of this wording off of the Docusaurus introduction page. ","\ud83d\udc83"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"We believe that, as developers, knowing how something works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various aspects of flecks with the hope that users reading it will gain a deeper understanding and be even more proficient in using it."}),"\n",(0,s.jsx)(n.h2,{id:"staying-informed",children:"Staying informed"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"https://github.com/cha0s/flecks",children:"GitHub"})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"something-missing",children:"Something missing?"}),"\n",(0,s.jsxs)(n.p,{children:["If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please ",(0,s.jsx)(n.a,{href:"https://github.com/cha0s/flecks/issues/new",children:"file an issue"})," for us."]})]})}function h(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},1151:(e,n,i)=>{i.d(n,{Z:()=>l,a:()=>r});var s=i(7294);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f9a0490a.384ce55d.js b/assets/js/f9a0490a.384ce55d.js
new file mode 100644
index 00000000..18497e1b
--- /dev/null
+++ b/assets/js/f9a0490a.384ce55d.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[3630],{9734:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var r=n(5893),o=n(1151);const c={title:"Platforms",description:"It might matter where your code is running."},s=void 0,i={id:"platforms",title:"Platforms",description:"It might matter where your code is running.",source:"@site/docs/platforms.mdx",sourceDirName:".",slug:"/platforms",permalink:"/flecks/docs/platforms",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"Platforms",description:"It might matter where your code is running."},sidebar:"flecksSidebar",previous:{title:"Ordering",permalink:"/flecks/docs/ordering"},next:{title:"Documentation",permalink:"/flecks/docs/documentation"}},l={},a=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Platforms automatically discover flecks based on the platform where the code is running."}),"\n",(0,r.jsxs)(t.p,{children:["A fleck may provide a ",(0,r.jsx)(t.code,{children:"/client"})," or ",(0,r.jsx)(t.code,{children:"/server"})," path which is automatically included or excluded based\non the current platform."]}),"\n",(0,r.jsx)(t.admonition,{title:"For example",type:"tip",children:(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"@flecks/react"})," fleck includes a ",(0,r.jsx)(t.code,{children:"@flecks/react/client"})," and ",(0,r.jsx)(t.code,{children:"@flecks/react/server"})," fleck. So\nyou can simply add ",(0,r.jsx)(t.code,{children:"@flecks/react"})," to your ",(0,r.jsx)(t.code,{children:"build/flecks.yml"})," and it will include everything\nautomatically for the server and client side."]})})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>s});var r=n(7294);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f9a0490a.be9bef1a.js b/assets/js/f9a0490a.be9bef1a.js
deleted file mode 100644
index 2cba101e..00000000
--- a/assets/js/f9a0490a.be9bef1a.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[3630],{9734:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>c,metadata:()=>i,toc:()=>a});var r=n(5893),o=n(1151);const c={title:"Platforms",description:"It might matter where your code is running."},s=void 0,i={id:"platforms",title:"Platforms",description:"It might matter where your code is running.",source:"@site/docs/platforms.mdx",sourceDirName:".",slug:"/platforms",permalink:"/flecks/docs/platforms",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"Platforms",description:"It might matter where your code is running."},sidebar:"flecksSidebar",previous:{title:"Testing",permalink:"/flecks/docs/testing"},next:{title:"Documentation",permalink:"/flecks/docs/documentation"}},l={},a=[];function d(e){const t={admonition:"admonition",code:"code",p:"p",...(0,o.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.p,{children:"Platforms automatically discover flecks based on the platform where the code is running."}),"\n",(0,r.jsxs)(t.p,{children:["A fleck may provide a ",(0,r.jsx)(t.code,{children:"/client"})," or ",(0,r.jsx)(t.code,{children:"/server"})," path which is automatically included or excluded based\non the current platform."]}),"\n",(0,r.jsx)(t.admonition,{title:"For example",type:"tip",children:(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"@flecks/react"})," fleck includes a ",(0,r.jsx)(t.code,{children:"@flecks/react/client"})," and ",(0,r.jsx)(t.code,{children:"@flecks/react/server"})," fleck. So\nyou can simply add ",(0,r.jsx)(t.code,{children:"@flecks/react"})," to your ",(0,r.jsx)(t.code,{children:"build/flecks.yml"})," and it will include everything\nautomatically for the server and client side."]})})]})}function u(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>s});var r=n(7294);const o={},c=r.createContext(o);function s(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/main.3c11ba53.js b/assets/js/main.b644f4bd.js
similarity index 93%
rename from assets/js/main.3c11ba53.js
rename to assets/js/main.b644f4bd.js
index d45564a3..02ddb62c 100644
--- a/assets/js/main.3c11ba53.js
+++ b/assets/js/main.b644f4bd.js
@@ -1,2 +1,2 @@
-/*! For license information please see main.3c11ba53.js.LICENSE.txt */
-(self.webpackChunkflecks_docusaurus=self.webpackChunkflecks_docusaurus||[]).push([[179],{5002:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});n(7294);var r=n(8356),o=n.n(r),a=n(1834);const i={"01a85c17":[()=>Promise.all([n.e(532),n.e(4013)]).then(n.bind(n,1223)),"@theme/BlogTagsListPage",1223],"01bbcd7b":[()=>n.e(6324).then(n.t.bind(n,1206,19)),"/home/cha0s/sync/src/code/flecks/website/node_modules/.cache/docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",1206],"041c5cc5":[()=>Promise.all([n.e(532),n.e(2312),n.e(9686)]).then(n.bind(n,5898)),"@site/docs/redux.mdx",5898],"06d8b529":[()=>Promise.all([n.e(532),n.e(2312),n.e(9091)]).then(n.bind(n,2127)),"@site/docs/database.mdx",2127],"0a6dca49":[()=>n.e(8151).then(n.t.bind(n,9583,19)),"~blog/default/flecks-blog-tags-introducing-be3.json",9583],"14eb3368":[()=>Promise.all([n.e(532),n.e(9817)]).then(n.bind(n,4228)),"@theme/DocCategoryGeneratedIndexPage",4228],"14f78a16":[()=>n.e(2163).then(n.t.bind(n,8506,19)),"~blog/default/flecks-blog-55a.json",8506],"160a3b85":[()=>n.e(6128).then(n.bind(n,3987)),"@site/docs/ordering.mdx",3987],"16e47f6f":[()=>n.e(2837).then(n.bind(n,2011)),"@site/docs/building-your-application.mdx",2011],17896441:[()=>Promise.all([n.e(532),n.e(2312),n.e(8071),n.e(7918)]).then(n.bind(n,5154)),"@theme/DocItem",5154],18911325:[()=>n.e(2873).then(n.bind(n,2494)),"@site/docs/docker.mdx",2494],"1dc09441":[()=>n.e(2528).then(n.bind(n,6711)),"@site/docs/testing.mdx",6711],"1ecec20c":[()=>n.e(3850).then(n.t.bind(n,7257,19)),"~docs/default/category-flecksdocs-fleckssidebar-category-generated-details-d06.json",7257],"2357b171":[()=>n.e(1695).then(n.t.bind(n,3048,19)),"~blog/default/flecks-blog-tags-announcement-75b-list.json",3048],"32a57bab":[()=>Promise.all([n.e(532),n.e(8532)]).then(n.bind(n,2343)),"@site/docs/sockets.mdx",2343],"32e8e2d9":[()=>n.e(1156).then(n.bind(n,8012)),"@site/blog/2024-01-30/introducing-flecks.mdx",8012],"357e2da2":[()=>n.e(2596).then(n.t.bind(n,8055,19)),"~docs/default/category-flecksdocs-fleckssidebar-category-getting-started-69a.json",8055],"3c291670":[()=>Promise.all([n.e(532),n.e(2312),n.e(1052)]).then(n.bind(n,2242)),"@site/docs/react.mdx",2242],"3d909a3c":[()=>n.e(4138).then(n.t.bind(n,3814,19)),"~blog/default/flecks-blog-tags-flecks-2a4.json",3814],"55ec95f7":[()=>Promise.all([n.e(532),n.e(6419)]).then(n.bind(n,3688)),"@site/pages/flecks/index.jsx",3688],"57cdf011":[()=>Promise.all([n.e(532),n.e(2312),n.e(944)]).then(n.bind(n,6586)),"@site/docs/flecks/todos.mdx",6586],"5df00a39":[()=>n.e(4364).then(n.bind(n,732)),"@site/docs/electron.mdx",732],"5e95c892":[()=>n.e(9661).then(n.bind(n,1892)),"@theme/DocsRoot",1892],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,8970)),"@generated/docusaurus.config",8970],"6875c492":[()=>Promise.all([n.e(532),n.e(2312),n.e(8071),n.e(130),n.e(8610)]).then(n.bind(n,1714)),"@theme/BlogTagsPostsPage",1714],"6cabb5ed":[()=>n.e(9339).then(n.bind(n,2034)),"@site/docs/building-your-fleck.mdx",2034],72512343:[()=>Promise.all([n.e(532),n.e(5679)]).then(n.bind(n,6057)),"@site/docs/flecks/hooks.mdx",6057],"773fe5c0":[()=>Promise.all([n.e(532),n.e(2312),n.e(1144)]).then(n.bind(n,9192)),"@site/docs/flecks/config.mdx",9192],"814f3328":[()=>n.e(2535).then(n.t.bind(n,2625,19)),"~blog/default/blog-post-list-prop-default.json",2625],"8333feff":[()=>n.e(7279).then(n.t.bind(n,9779,19)),"~blog/default/flecks-blog-tags-introducing-be3-list.json",9779],"8b0cd02a":[()=>Promise.all([n.e(532),n.e(2312),n.e(6911)]).then(n.bind(n,1039)),"@site/docs/repl.mdx",1039],"8d2f4c1c":[()=>n.e(5287).then(n.t.bind(n,1774,19)),"/home/cha0s/sync/src/code/flecks/website/node_modules/.cache/docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",1774],"8d4b214a":[()=>n.e(4639).then(n.bind(n,3839)),"@site/docs/adding-flecks.mdx",3839],"8f92789c":[()=>Promise.all([n.e(532),n.e(6325)]).then(n.bind(n,9458)),"@site/pages/index.jsx",9458],"935f2afb":[()=>n.e(53).then(n.t.bind(n,7676,19)),"~docs/default/version-current-metadata-prop-751.json",7676],"972d9d57":[()=>n.e(937).then(n.bind(n,3134)),"@site/docs/introduction.mdx",3134],"9967cc6c":[()=>n.e(1073).then(n.bind(n,3899)),"@site/docs/hooks.mdx",3899],"9e4087bc":[()=>n.e(3608).then(n.bind(n,3169)),"@theme/BlogArchivePage",3169],a0957561:[()=>n.e(5048).then(n.t.bind(n,8536,19)),"~blog/default/flecks-blog-archive-6c6.json",8536],a6aa9e1f:[()=>Promise.all([n.e(532),n.e(2312),n.e(8071),n.e(130),n.e(3089)]).then(n.bind(n,46)),"@theme/BlogListPage",46],a7bd4aaa:[()=>n.e(8518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a94703ab:[()=>Promise.all([n.e(532),n.e(4368)]).then(n.bind(n,2674)),"@theme/DocRoot",2674],af7d3287:[()=>n.e(3541).then(n.bind(n,8065)),"@site/docs/environment.mdx",8065],b045326f:[()=>n.e(1851).then(n.bind(n,4345)),"@site/docs/documentation.mdx",4345],ba61d949:[()=>Promise.all([n.e(532),n.e(2312),n.e(7041)]).then(n.bind(n,5053)),"@site/docs/cli.mdx",5053],bb194406:[()=>n.e(8883).then(n.bind(n,8076)),"@site/blog/2024-01-30/introducing-flecks.mdx?truncated=true",8076],be07d3f5:[()=>n.e(1204).then(n.bind(n,1538)),"@site/docs/creating-a-fleck.mdx",1538],bfa2a205:[()=>n.e(8312).then(n.t.bind(n,5143,19)),"~docs/default/category-flecksdocs-fleckssidebar-category-guides-724.json",5143],c208b484:[()=>n.e(1825).then(n.bind(n,5019)),"@site/docs/gathering.mdx",5019],c6694cff:[()=>n.e(5722).then(n.t.bind(n,3363,19)),"~blog/default/flecks-blog-tags-tags-674.json",3363],c6ac44d3:[()=>n.e(1540).then(n.t.bind(n,3928,19)),"~blog/default/flecks-blog-tags-release-5c4.json",3928],cbb899e4:[()=>n.e(196).then(n.bind(n,8282)),"@site/docs/configuration.mdx",8282],ccc49370:[()=>Promise.all([n.e(532),n.e(2312),n.e(8071),n.e(130),n.e(6103)]).then(n.bind(n,5203)),"@theme/BlogPostPage",5203],cdb1c15d:[()=>n.e(107).then(n.t.bind(n,8175,19)),"~blog/default/flecks-blog-tags-flecks-2a4-list.json",8175],cdde611f:[()=>n.e(4100).then(n.t.bind(n,20,19)),"/home/cha0s/sync/src/code/flecks/website/node_modules/.cache/docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json",20],dad808ed:[()=>n.e(9832).then(n.t.bind(n,1281,19)),"~docs/default/category-flecksdocs-fleckssidebar-category-writing-your-flecks-ad3.json",1281],e6ab389f:[()=>n.e(2297).then(n.t.bind(n,9098,19)),"~blog/default/flecks-blog-tags-release-5c4-list.json",9098],e98a169a:[()=>n.e(4861).then(n.t.bind(n,2576,19)),"~blog/default/flecks-blog-tags-announcement-75b.json",2576],f9a0490a:[()=>n.e(3630).then(n.bind(n,9734)),"@site/docs/platforms.mdx",9734],fa4d91bf:[()=>Promise.all([n.e(532),n.e(2312),n.e(5930)]).then(n.bind(n,4099)),"@site/docs/installation.mdx",4099],fb49b6cf:[()=>n.e(9828).then(n.bind(n,30)),"@site/docs/flecks/build-files.mdx",30]};var l=n(5893);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(9670),u=n(226);function d(e,t){if("*"===e)return o()({loading:s,loader:()=>n.e(1772).then(n.bind(n,1772)),modules:["@theme/NotFound"],webpack:()=>[1772],render(e,t){const n=e.default;return(0,l.jsx)(u.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},f=[],p=[],m=(0,c.Z)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],f.push(r[1]),p.push(r[2]))})),o().Map({loading:s,loader:d,modules:f,webpack:()=>p,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;return delete o.__context,(0,l.jsx)(u.z,{value:i,children:(0,l.jsx)(a,{...o,...n})})}})}const f=[{path:"/flecks/blog",component:d("/flecks/blog","173"),exact:!0},{path:"/flecks/blog/archive",component:d("/flecks/blog/archive","b63"),exact:!0},{path:"/flecks/blog/introducing-flecks",component:d("/flecks/blog/introducing-flecks","f4d"),exact:!0},{path:"/flecks/blog/tags",component:d("/flecks/blog/tags","9cb"),exact:!0},{path:"/flecks/blog/tags/announcement",component:d("/flecks/blog/tags/announcement","23a"),exact:!0},{path:"/flecks/blog/tags/flecks",component:d("/flecks/blog/tags/flecks","101"),exact:!0},{path:"/flecks/blog/tags/introducing",component:d("/flecks/blog/tags/introducing","8b5"),exact:!0},{path:"/flecks/blog/tags/release",component:d("/flecks/blog/tags/release","32d"),exact:!0},{path:"/flecks/flecks",component:d("/flecks/flecks","0dd"),exact:!0},{path:"/flecks/docs",component:d("/flecks/docs","7fd"),routes:[{path:"/flecks/docs",component:d("/flecks/docs","dd4"),routes:[{path:"/flecks/docs",component:d("/flecks/docs","659"),routes:[{path:"/flecks/docs",component:d("/flecks/docs","742"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/adding-flecks",component:d("/flecks/docs/adding-flecks","372"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/building-your-application",component:d("/flecks/docs/building-your-application","f6c"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/building-your-fleck",component:d("/flecks/docs/building-your-fleck","091"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/category/generated-details",component:d("/flecks/docs/category/generated-details","a6e"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/category/getting-started",component:d("/flecks/docs/category/getting-started","e49"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/category/guides",component:d("/flecks/docs/category/guides","729"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/category/writing-your-flecks",component:d("/flecks/docs/category/writing-your-flecks","408"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/cli",component:d("/flecks/docs/cli","882"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/configuration",component:d("/flecks/docs/configuration","399"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/creating-a-fleck",component:d("/flecks/docs/creating-a-fleck","8d3"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/database",component:d("/flecks/docs/database","c2c"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/docker",component:d("/flecks/docs/docker","0ea"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/documentation",component:d("/flecks/docs/documentation","227"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/electron",component:d("/flecks/docs/electron","437"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/environment",component:d("/flecks/docs/environment","9ae"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/flecks/build-files",component:d("/flecks/docs/flecks/build-files","749"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/flecks/config",component:d("/flecks/docs/flecks/config","6bc"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/flecks/hooks",component:d("/flecks/docs/flecks/hooks","cd1"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/flecks/todos",component:d("/flecks/docs/flecks/todos","4a8"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/gathering",component:d("/flecks/docs/gathering","e63"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/hooks",component:d("/flecks/docs/hooks","14d"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/installation",component:d("/flecks/docs/installation","145"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/ordering",component:d("/flecks/docs/ordering","2dd"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/platforms",component:d("/flecks/docs/platforms","039"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/react",component:d("/flecks/docs/react","ce0"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/redux",component:d("/flecks/docs/redux","b6c"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/repl",component:d("/flecks/docs/repl","7ca"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/sockets",component:d("/flecks/docs/sockets","f16"),exact:!0,sidebar:"flecksSidebar"},{path:"/flecks/docs/testing",component:d("/flecks/docs/testing","442"),exact:!0,sidebar:"flecksSidebar"}]}]}]},{path:"/flecks/",component:d("/flecks/","ace"),exact:!0},{path:"*",component:d("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>i});var r=n(7294),o=n(5893);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},7428:(e,t,n)=>{"use strict";var r=n(7294),o=n(745),a=n(3727),i=n(405),l=n(412);const s=[n(2497),n(3310),n(8320)];var c=n(5002),u=n(6550),d=n(8790),f=n(5893);function p(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var m=n(5742),g=n(2263),h=n(4996),b=n(6668),y=n(1944),v=n(4711),k=n(9727),w=n(3320),x=n(8780),S=n(197);function E(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,g.Z)(),r=(0,v.l)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(m.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function C(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,g.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,g.Z)(),{pathname:r}=(0,u.TH)();return e+(0,x.applyTrailingSlash)((0,h.Z)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,f.jsxs)(m.Z,{children:[(0,f.jsx)("meta",{property:"og:url",content:o}),(0,f.jsx)("link",{rel:"canonical",href:o})]})}function _(){const{i18n:{currentLocale:e}}=(0,g.Z)(),{metadata:t,image:n}=(0,b.L)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(m.Z,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:k.h})]}),n&&(0,f.jsx)(y.d,{image:n}),(0,f.jsx)(C,{}),(0,f.jsx)(E,{}),(0,f.jsx)(S.Z,{tag:w.HX,locale:e}),(0,f.jsx)(m.Z,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const T=new Map;function j(e){if(T.has(e.pathname))return{...e,pathname:T.get(e.pathname)};if((0,d.f)(c.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return T.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return T.set(e.pathname,t),{...e,pathname:t}}var L=n(8934),A=n(6565),N=n(469);function R(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;rYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment
can become .namespace--comment
) or replace them with your defined ones (like .editor__comment
). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll
and highlightAllUnder
methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),o=n(9642),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),a.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;sYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment
can become .namespace--comment
) or replace them with your defined ones (like .editor__comment
). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll
and highlightAllUnder
methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),o=n(9642),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),a.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s