diff --git a/404.html b/404.html index 6d9da69a..8f1af81e 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Page Not Found | Watcharr Docs - + diff --git a/assets/js/568bc3e4.1ef3dca6.js b/assets/js/568bc3e4.1ef3dca6.js deleted file mode 100644 index b1cbcbc5..00000000 --- a/assets/js/568bc3e4.1ef3dca6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(globalThis.webpackChunkwatcharr_doc=globalThis.webpackChunkwatcharr_doc||[]).push([[97],{6360(e,n,o){o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>s,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"installation/for-development","title":"For Development","description":"Building from source for developing upon Watcharr.","source":"@site/docs/installation/for-development.md","sourceDirName":"installation","slug":"/installation/for-development","permalink":"/docs/installation/for-development","draft":false,"unlisted":false,"editUrl":"https://github.com/sbondCo/Watcharr/tree/dev/doc/docs/installation/for-development.md","tags":[],"version":"current","sidebarPosition":11,"frontMatter":{"sidebar_position":11,"description":"Building from source for developing upon Watcharr."},"sidebar":"tutorialSidebar","previous":{"title":"From Source","permalink":"/docs/installation/from-source"},"next":{"title":"Server Configuration","permalink":"/docs/category/server-configuration"}}');var t=o(4848),i=o(8453);const s={sidebar_position:11,description:"Building from source for developing upon Watcharr."},l="For Development",d={},c=[{value:"Setup",id:"setup",level:2},{value:"Setting Up Dependencies",id:"setting-up-dependencies",level:2},{value:"Running The Code",id:"running-the-code",level:2}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"for-development",children:"For Development"})}),"\n",(0,t.jsx)(n.p,{children:"This guide will help you setup Watcharr for development in your local environment."}),"\n",(0,t.jsx)(n.h2,{id:"setup",children:"Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section assumes you will be forking the repo on Github, of course you can alter this section to work with your workflow, but if you intend to create a pull request with your work, it may be difficult if you're not also using Github (I don't know :())."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Fork the repository"}),"\n",(0,t.jsx)(n.p,{children:"On GitHub you can fork the repository with the 'Fork' button at the top."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{alt:"Fork button",src:o(5985).A+"",width:"148",height:"39"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Get the code by cloning your fork"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com//Watcharr.git && \\\ncd Watcharr\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"setting-up-dependencies",children:"Setting Up Dependencies"}),"\n",(0,t.jsx)(n.p,{children:"You only need to do this once after pulling the codebase for the first time, and again every time the dependencies are changed/updated."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Install frontend dependencies (in the project root folder)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"npm i\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install server dependencies (in the ",(0,t.jsx)(n.code,{children:"server"})," folder)"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"go get .\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"running-the-code",children:"Running The Code"}),"\n",(0,t.jsx)(n.p,{children:"To run the code, you will need to open up two terminals, one for the frontend and the other for the backend."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run the frontend (first terminal, in the project root folder)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm run dev\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run the server (second terminal, in the project root folder)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"npm run server\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," If you're using Windows, running the server can be a little more complicated. You can follow this: ",(0,t.jsx)(n.a,{href:"https://github.com/sbondCo/Watcharr/discussions/430#discussioncomment-8894110",children:"https://github.com/sbondCo/Watcharr/discussions/430#discussioncomment-8894110"})," which amounts to these steps (the first 3 steps only need to be done once):"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Set CGO_ENABLED environment variable with go"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"go env -w CGO_ENABLED=1\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install ",(0,t.jsx)(n.code,{children:"gcc"})," (if you don't already have it installed) from ",(0,t.jsx)(n.a,{href:"https://jmeubank.github.io/tdm-gcc/",children:"https://jmeubank.github.io/tdm-gcc/"})," (found from this answer on stackoverflow: ",(0,t.jsx)(n.a,{href:"https://stackoverflow.com/a/43588236",children:"https://stackoverflow.com/a/43588236"}),")."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install server dependencies again with ",(0,t.jsx)(n.code,{children:"go get ."})," in the ",(0,t.jsx)(n.code,{children:"server"})," folder."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Manually run the server, setting the MODE environment variable in powershell (from the ",(0,t.jsx)(n.code,{children:"server"})," folder)"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'cmd /V /C "set MODE=DEV&& go run ."\n'})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Visit ",(0,t.jsx)(n.a,{href:"http://localhost:5173/",children:"http://localhost:5173/"})," and setup Watcharr."]}),"\n"]}),"\n"]})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},5985(e,n,o){o.d(n,{A:()=>r});const r="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJQAAAAnCAMAAADevJE9AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB41BMVEX////n6+/Y3ePR2N/Q1973+Pnd4+ft8fP2+Prk6e3x9Pbs7/Lq7fDp7PDo6+/u8fTa3eF1fYZjbHajqbCjqa91fIVrdH6Ql56+w8iRmJ+ssrj29uWfXjdKkNXz+Prj5urrrm0rKS8kKS8kKTNQl9vo6+zUtYpTODVNkNHl6++an6csOnSk0NfS1NfS1Nja6PXo6uTAl2o8Ok1EPjW1usAtPoO/8/r2+PTXsYhcRz4rMDo9VXqdzO31+PqfX0Btq8aWaU0xNWah3+Pz+PnqyJBPN012ueb0+Pro6dqmgH+ZxsyOVTbyz5RKMUdpoMjT19CvglgwP3mz6PmfXjYwOU9ejK+6wdPg8+Xu26tkPkJfodrw+Pro6NKOUzbIzNErKjAnKzEnLkqAx/PMjFAsVJrV9fr27rpuODpnr+6fXjUwarLm9/qfXjhNiKaATz5MiMjo9/qHjpbS1dzi8PW7eUAsaLHq+Pr29c6FSDZWnuH09uVHjNEtNTspLDpWmtjx+Prt7/F+ho72+PfNjVBosO9HjtI6cbPNsXY7NFuQ0PN9ho7z05lQNEhqo8rV3NW0hlowO3Sv5/nz9+i0dUYtUpPK8PrR1dj2+PXbt41eSj8sLzk6U3WWyOr16L11QzdJicvs+PqmR/6GAAAAAWJLR0QAiAUdSAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAd0SU1FB+gDGgUYG0BybToAAAJRSURBVFjD7df3d9JQFAfwNlC4hZTCFUIkgWDrxK1xW/eqW+uede9R925j3aPuusefahIghKwD+NT3Q74/8A7J4fA59768vNfU5MePHz+2NDOB4P9OgGk2k1qYUBj+SYJeN8MhpqWCYloBKEABtDKV3oWAEhSEjA4ypHoXibJtsVLa2GikflTYKFWAEImNWcJG6kVBoIwKEjG1xxzSXi8q6IKKJ3CENiYxEf9Dk03VMCrFpZEH4DHNJWrvXcwlETIoHBnHDEAG42n0+r0gZnPGF9YNxZJBJRE5CUDiEJOVq/lRHR2do3MuqHKhxowdN36CMdhL1TAKCihpg4QF08X8xEmTp0x1q1S0CJg2fcZMVVMaiomSQamN0yc8ymbUrNnq55y58+YvWNglLFq8ZOkyMbt8xcpVq03dW9O9dp2qKQ0O/WscpTVOCyfZUOs3bNy0ectWoWfb9h07xeyu3Xv26neNNXPffl1TGvRV1BV1oPg3ck0okORMKpWRzSbIH+ztPXT4yNFjcPzESeHU6TMgnD13/sJFaBylPuBqCrVVSktfn+WCNqcuXb5y9Rpcv3Hzlng7B0LPnbv3+i0Pnx3l1T7eavJEDSjKgAWlte/+oF6pB4L4UEM9evzkadVEd0J5TnQ+CbWjniEqDih4/uLl0KvXb4ooMfv23fsP1WunHUVoSQAYRlnGYQfUx0+fv3z91lVG5b7/+Pmrqn82FKHFU1+iFAWlurYIf/k1o/ea43gCmwRyL2Q6ti5UbvKo3A5TeXCg8ohF52GUymO7Hz/k8humt8q7qOKb1wAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wMy0yNlQwNToyMTozMSswMDowMPa/58MAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDMtMjZUMDU6MjE6MzErMDA6MDCH4l9/AAAAAElFTkSuQmCC"},8453(e,n,o){o.d(n,{R:()=>s,x:()=>l});var r=o(6540);const t={},i=r.createContext(t);function s(e){const n=r.useContext(i);return r.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:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/568bc3e4.4c00deee.js b/assets/js/568bc3e4.4c00deee.js new file mode 100644 index 00000000..45218559 --- /dev/null +++ b/assets/js/568bc3e4.4c00deee.js @@ -0,0 +1 @@ +"use strict";(globalThis.webpackChunkwatcharr_doc=globalThis.webpackChunkwatcharr_doc||[]).push([[97],{6360(e,n,o){o.r(n),o.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"installation/for-development","title":"For Development","description":"Building from source for developing upon Watcharr.","source":"@site/docs/installation/for-development.md","sourceDirName":"installation","slug":"/installation/for-development","permalink":"/docs/installation/for-development","draft":false,"unlisted":false,"editUrl":"https://github.com/sbondCo/Watcharr/tree/dev/doc/docs/installation/for-development.md","tags":[],"version":"current","sidebarPosition":11,"frontMatter":{"sidebar_position":11,"description":"Building from source for developing upon Watcharr."},"sidebar":"tutorialSidebar","previous":{"title":"From Source","permalink":"/docs/installation/from-source"},"next":{"title":"Server Configuration","permalink":"/docs/category/server-configuration"}}');var t=o(4848),i=o(8453);const s={sidebar_position:11,description:"Building from source for developing upon Watcharr."},l="For Development",d={},c=[{value:"Setup",id:"setup",level:2},{value:"Setting Up Dependencies",id:"setting-up-dependencies",level:2},{value:"Running The Code",id:"running-the-code",level:2}];function a(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",img:"img",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"for-development",children:"For Development"})}),"\n",(0,t.jsx)(n.p,{children:"This guide will help you setup Watcharr for development in your local environment."}),"\n",(0,t.jsx)(n.h2,{id:"setup",children:"Setup"}),"\n",(0,t.jsx)(n.p,{children:"This section assumes you will be forking the repo on Github, of course you can alter this section to work with your workflow, but if you intend to create a pull request with your work, it may be difficult if you're not also using Github (I don't know :())."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Fork the repository"}),"\n",(0,t.jsx)(n.p,{children:"On GitHub you can fork the repository with the 'Fork' button at the top."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{alt:"Fork button",src:o(5985).A+"",width:"148",height:"39"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Get the code by cloning your fork (edit the command and replace ",(0,t.jsx)(n.code,{children:""})," with your GitHub username or replace the whole url with the correct one pointing to your fork)."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"git clone https://github.com//Watcharr.git && \\\ncd Watcharr\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"setting-up-dependencies",children:"Setting Up Dependencies"}),"\n",(0,t.jsx)(n.p,{children:"You only need to do this once after pulling the codebase for the first time, and again every time the dependencies are changed/updated."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Install frontend dependencies (in the project root folder)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"npm i\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install server dependencies (in the ",(0,t.jsx)(n.code,{children:"server"})," folder). Go does this automatically if you try starting the server and it notices you don't have them."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"go get .\n"})}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"running-the-code",children:"Running The Code"}),"\n",(0,t.jsx)(n.p,{children:"To run the code, you will need to open up two terminals, one for the frontend and the other for the backend."}),"\n",(0,t.jsxs)(n.p,{children:["We have ",(0,t.jsx)(n.code,{children:"Makefile"}),"s for the frontend and server, so you can simply call ",(0,t.jsx)(n.code,{children:"make"})," in each directory. Most Linux distros (as far as I know) include ",(0,t.jsx)(n.code,{children:"make"}),", so you don't need to install anything. If you don't have ",(0,t.jsx)(n.code,{children:"make"}),', you can either install it (lookup how to get "GNU Make" for your specific OS) OR you can just look inside the Makefiles and manually run the first command in each.']}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Run the frontend (first terminal, in the project root folder)"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"make\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Run the server (second terminal, in the ",(0,t.jsx)(n.code,{children:"server"})," folder)"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-bash",children:"make\n"})}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," If you're using Windows, running the server can be a little more complicated. You can follow this: ",(0,t.jsx)(n.a,{href:"https://github.com/sbondCo/Watcharr/discussions/430#discussioncomment-8894110",children:"https://github.com/sbondCo/Watcharr/discussions/430#discussioncomment-8894110"})," which amounts to these steps (the first 3 steps only need to be done once):"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Set CGO_ENABLED environment variable with go"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:"go env -w CGO_ENABLED=1\n"})}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install ",(0,t.jsx)(n.code,{children:"gcc"})," (if you don't already have it installed) from ",(0,t.jsx)(n.a,{href:"https://jmeubank.github.io/tdm-gcc/",children:"https://jmeubank.github.io/tdm-gcc/"})," (found from this answer on stackoverflow: ",(0,t.jsx)(n.a,{href:"https://stackoverflow.com/a/43588236",children:"https://stackoverflow.com/a/43588236"}),")."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Install server dependencies again with ",(0,t.jsx)(n.code,{children:"go get ."})," in the ",(0,t.jsx)(n.code,{children:"server"})," folder."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Manually run the server, setting the MODE environment variable in powershell (from the ",(0,t.jsx)(n.code,{children:"server"})," folder)"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{children:'cmd /V /C "set MODE=DEV&& go run ."\n'})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Visit ",(0,t.jsx)(n.a,{href:"http://localhost:5173/",children:"http://localhost:5173/"})," and setup Watcharr."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},5985(e,n,o){o.d(n,{A:()=>r});const r="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJQAAAAnCAMAAADevJE9AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB41BMVEX////n6+/Y3ePR2N/Q1973+Pnd4+ft8fP2+Prk6e3x9Pbs7/Lq7fDp7PDo6+/u8fTa3eF1fYZjbHajqbCjqa91fIVrdH6Ql56+w8iRmJ+ssrj29uWfXjdKkNXz+Prj5urrrm0rKS8kKS8kKTNQl9vo6+zUtYpTODVNkNHl6++an6csOnSk0NfS1NfS1Nja6PXo6uTAl2o8Ok1EPjW1usAtPoO/8/r2+PTXsYhcRz4rMDo9VXqdzO31+PqfX0Btq8aWaU0xNWah3+Pz+PnqyJBPN012ueb0+Pro6dqmgH+ZxsyOVTbyz5RKMUdpoMjT19CvglgwP3mz6PmfXjYwOU9ejK+6wdPg8+Xu26tkPkJfodrw+Pro6NKOUzbIzNErKjAnKzEnLkqAx/PMjFAsVJrV9fr27rpuODpnr+6fXjUwarLm9/qfXjhNiKaATz5MiMjo9/qHjpbS1dzi8PW7eUAsaLHq+Pr29c6FSDZWnuH09uVHjNEtNTspLDpWmtjx+Prt7/F+ho72+PfNjVBosO9HjtI6cbPNsXY7NFuQ0PN9ho7z05lQNEhqo8rV3NW0hlowO3Sv5/nz9+i0dUYtUpPK8PrR1dj2+PXbt41eSj8sLzk6U3WWyOr16L11QzdJicvs+PqmR/6GAAAAAWJLR0QAiAUdSAAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAAd0SU1FB+gDGgUYG0BybToAAAJRSURBVFjD7df3d9JQFAfwNlC4hZTCFUIkgWDrxK1xW/eqW+uede9R925j3aPuusefahIghKwD+NT3Q74/8A7J4fA59768vNfU5MePHz+2NDOB4P9OgGk2k1qYUBj+SYJeN8MhpqWCYloBKEABtDKV3oWAEhSEjA4ypHoXibJtsVLa2GikflTYKFWAEImNWcJG6kVBoIwKEjG1xxzSXi8q6IKKJ3CENiYxEf9Dk03VMCrFpZEH4DHNJWrvXcwlETIoHBnHDEAG42n0+r0gZnPGF9YNxZJBJRE5CUDiEJOVq/lRHR2do3MuqHKhxowdN36CMdhL1TAKCihpg4QF08X8xEmTp0x1q1S0CJg2fcZMVVMaiomSQamN0yc8ymbUrNnq55y58+YvWNglLFq8ZOkyMbt8xcpVq03dW9O9dp2qKQ0O/WscpTVOCyfZUOs3bNy0ectWoWfb9h07xeyu3Xv26neNNXPffl1TGvRV1BV1oPg3ck0okORMKpWRzSbIH+ztPXT4yNFjcPzESeHU6TMgnD13/sJFaBylPuBqCrVVSktfn+WCNqcuXb5y9Rpcv3Hzlng7B0LPnbv3+i0Pnx3l1T7eavJEDSjKgAWlte/+oF6pB4L4UEM9evzkadVEd0J5TnQ+CbWjniEqDih4/uLl0KvXb4ooMfv23fsP1WunHUVoSQAYRlnGYQfUx0+fv3z91lVG5b7/+Pmrqn82FKHFU1+iFAWlurYIf/k1o/ea43gCmwRyL2Q6ti5UbvKo3A5TeXCg8ohF52GUymO7Hz/k8humt8q7qOKb1wAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wMy0yNlQwNToyMTozMSswMDowMPa/58MAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDMtMjZUMDU6MjE6MzErMDA6MDCH4l9/AAAAAElFTkSuQmCC"},8453(e,n,o){o.d(n,{R:()=>s,x:()=>l});var r=o(6540);const t={},i=r.createContext(t);function s(e){const n=r.useContext(i);return r.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:s(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.b84888b6.js b/assets/js/runtime~main.9a9f349d.js similarity index 98% rename from assets/js/runtime~main.b84888b6.js rename to assets/js/runtime~main.9a9f349d.js index 128f6b8f..e12be175 100644 --- a/assets/js/runtime~main.b84888b6.js +++ b/assets/js/runtime~main.9a9f349d.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,r,t,d,o={},c={};function n(e){var a=c[e];if(void 0!==a)return a.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return o[e].call(r.exports,r,r.exports,n),r.loaded=!0,r.exports}n.m=o,n.c=c,e=[],n.O=(a,r,t,d)=>{if(!r){var o=1/0;for(i=0;i=d)&&Object.keys(n.O).every(e=>n.O[e](r[f]))?r.splice(f--,1):(c=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[r,t,d]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var d=Object.create(null);n.r(d);var o={};a=a||[null,r({}),r([]),r(r)];for(var c=2&t&&e;("object"==typeof c||"function"==typeof c)&&!~a.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach(a=>o[a]=()=>e[a]);return o.default=()=>e,n.d(d,o),d},n.d=(e,a)=>{for(var r in a)n.o(a,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:a[r]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce((a,r)=>(n.f[r](e,a),a),[])),n.u=e=>"assets/js/"+({48:"a94703ab",61:"1f391b9e",97:"568bc3e4",98:"a7bd4aaa",134:"393be207",157:"c742a5ec",235:"a7456010",287:"b0e6f294",299:"d8d80848",303:"d9e31b1c",352:"8cfff9c6",361:"d37720bd",401:"17896441",449:"828ae7da",461:"d294ea5b",514:"6885b268",527:"e38456de",545:"f12d36e3",618:"45afa828",634:"c4f5d8e4",647:"5e95c892",671:"8494da2d",742:"aba21aa0",849:"0058b4c6",869:"760d6d76",887:"aa9d541a",899:"a09c2993",969:"14eb3368",990:"809512ee",996:"6b269b4f"}[e]||e)+"."+{48:"5e89ff31",61:"f6452e68",97:"1ef3dca6",98:"5c80c731",134:"77279b04",157:"62b9efe6",235:"690e10ce",237:"87ce40e0",285:"ecf30459",287:"8cd2710d",299:"ebec2bb9",303:"c2d8aa4b",352:"ea08dd5a",361:"926f1f6d",401:"a877991e",449:"8d5e1ada",461:"4573b1f1",514:"0ccd16fa",527:"20ed0ade",545:"6512db9b",618:"9315791c",634:"f084dabe",647:"9c713677",671:"a80f25ad",742:"1f888d55",849:"47da1b4d",869:"046a0bd6",887:"f25f6844",891:"e57a69c4",899:"82b1b8de",969:"fff76230",990:"17472274",996:"6fa89571"}[e]+".js",n.miniCssF=e=>{},n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},d="watcharr-doc:",n.l=(e,a,r,o)=>{if(t[e])t[e].push(a);else{var c,f;if(void 0!==r)for(var b=document.getElementsByTagName("script"),i=0;i{c.onerror=c.onload=null,clearTimeout(s);var d=t[e];if(delete t[e],c.parentNode&&c.parentNode.removeChild(c),d&&d.forEach(e=>e(r)),a)return a(r)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=u.bind(null,c.onerror),c.onload=u.bind(null,c.onload),f&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/",n.gca=function(e){return e={17896441:"401",a94703ab:"48","1f391b9e":"61","568bc3e4":"97",a7bd4aaa:"98","393be207":"134",c742a5ec:"157",a7456010:"235",b0e6f294:"287",d8d80848:"299",d9e31b1c:"303","8cfff9c6":"352",d37720bd:"361","828ae7da":"449",d294ea5b:"461","6885b268":"514",e38456de:"527",f12d36e3:"545","45afa828":"618",c4f5d8e4:"634","5e95c892":"647","8494da2d":"671",aba21aa0:"742","0058b4c6":"849","760d6d76":"869",aa9d541a:"887",a09c2993:"899","14eb3368":"969","809512ee":"990","6b269b4f":"996"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,250:0};n.f.j=(a,r)=>{var t=n.o(e,a)?e[a]:void 0;if(0!==t)if(t)r.push(t[2]);else if(/^(250|354)$/.test(a))e[a]=0;else{var d=new Promise((r,d)=>t=e[a]=[r,d]);r.push(t[2]=d);var o=n.p+n.u(a),c=new Error;n.l(o,r=>{if(n.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var d=r&&("load"===r.type?"missing":r.type),o=r&&r.target&&r.target.src;c.message="Loading chunk "+a+" failed.\n("+d+": "+o+")",c.name="ChunkLoadError",c.type=d,c.request=o,t[1](c)}},"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,r)=>{var t,d,[o,c,f]=r,b=0;if(o.some(a=>0!==e[a])){for(t in c)n.o(c,t)&&(n.m[t]=c[t]);if(f)var i=f(n)}for(a&&a(r);b{"use strict";var e,a,r,t,d,o={},c={};function n(e){var a=c[e];if(void 0!==a)return a.exports;var r=c[e]={id:e,loaded:!1,exports:{}};return o[e].call(r.exports,r,r.exports,n),r.loaded=!0,r.exports}n.m=o,n.c=c,e=[],n.O=(a,r,t,d)=>{if(!r){var o=1/0;for(i=0;i=d)&&Object.keys(n.O).every(e=>n.O[e](r[f]))?r.splice(f--,1):(c=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[r,t,d]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var d=Object.create(null);n.r(d);var o={};a=a||[null,r({}),r([]),r(r)];for(var c=2&t&&e;("object"==typeof c||"function"==typeof c)&&!~a.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach(a=>o[a]=()=>e[a]);return o.default=()=>e,n.d(d,o),d},n.d=(e,a)=>{for(var r in a)n.o(a,r)&&!n.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:a[r]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce((a,r)=>(n.f[r](e,a),a),[])),n.u=e=>"assets/js/"+({48:"a94703ab",61:"1f391b9e",97:"568bc3e4",98:"a7bd4aaa",134:"393be207",157:"c742a5ec",235:"a7456010",287:"b0e6f294",299:"d8d80848",303:"d9e31b1c",352:"8cfff9c6",361:"d37720bd",401:"17896441",449:"828ae7da",461:"d294ea5b",514:"6885b268",527:"e38456de",545:"f12d36e3",618:"45afa828",634:"c4f5d8e4",647:"5e95c892",671:"8494da2d",742:"aba21aa0",849:"0058b4c6",869:"760d6d76",887:"aa9d541a",899:"a09c2993",969:"14eb3368",990:"809512ee",996:"6b269b4f"}[e]||e)+"."+{48:"5e89ff31",61:"f6452e68",97:"4c00deee",98:"5c80c731",134:"77279b04",157:"62b9efe6",235:"690e10ce",237:"87ce40e0",285:"ecf30459",287:"8cd2710d",299:"ebec2bb9",303:"c2d8aa4b",352:"ea08dd5a",361:"926f1f6d",401:"a877991e",449:"8d5e1ada",461:"4573b1f1",514:"0ccd16fa",527:"20ed0ade",545:"6512db9b",618:"9315791c",634:"f084dabe",647:"9c713677",671:"a80f25ad",742:"1f888d55",849:"47da1b4d",869:"046a0bd6",887:"f25f6844",891:"e57a69c4",899:"82b1b8de",969:"fff76230",990:"17472274",996:"6fa89571"}[e]+".js",n.miniCssF=e=>{},n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},d="watcharr-doc:",n.l=(e,a,r,o)=>{if(t[e])t[e].push(a);else{var c,f;if(void 0!==r)for(var b=document.getElementsByTagName("script"),i=0;i{c.onerror=c.onload=null,clearTimeout(s);var d=t[e];if(delete t[e],c.parentNode&&c.parentNode.removeChild(c),d&&d.forEach(e=>e(r)),a)return a(r)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=u.bind(null,c.onerror),c.onload=u.bind(null,c.onload),f&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/",n.gca=function(e){return e={17896441:"401",a94703ab:"48","1f391b9e":"61","568bc3e4":"97",a7bd4aaa:"98","393be207":"134",c742a5ec:"157",a7456010:"235",b0e6f294:"287",d8d80848:"299",d9e31b1c:"303","8cfff9c6":"352",d37720bd:"361","828ae7da":"449",d294ea5b:"461","6885b268":"514",e38456de:"527",f12d36e3:"545","45afa828":"618",c4f5d8e4:"634","5e95c892":"647","8494da2d":"671",aba21aa0:"742","0058b4c6":"849","760d6d76":"869",aa9d541a:"887",a09c2993:"899","14eb3368":"969","809512ee":"990","6b269b4f":"996"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,250:0};n.f.j=(a,r)=>{var t=n.o(e,a)?e[a]:void 0;if(0!==t)if(t)r.push(t[2]);else if(/^(250|354)$/.test(a))e[a]=0;else{var d=new Promise((r,d)=>t=e[a]=[r,d]);r.push(t[2]=d);var o=n.p+n.u(a),c=new Error;n.l(o,r=>{if(n.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var d=r&&("load"===r.type?"missing":r.type),o=r&&r.target&&r.target.src;c.message="Loading chunk "+a+" failed.\n("+d+": "+o+")",c.name="ChunkLoadError",c.type=d,c.request=o,t[1](c)}},"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,r)=>{var t,d,[o,c,f]=r,b=0;if(o.some(a=>0!==e[a])){for(t in c)n.o(c,t)&&(n.m[t]=c[t]);if(f)var i=f(n)}for(a&&a(r);b Importing | Watcharr Docs - + diff --git a/docs/category/installation.html b/docs/category/installation.html index ab2cdb6a..9eb8d044 100644 --- a/docs/category/installation.html +++ b/docs/category/installation.html @@ -4,7 +4,7 @@ Installation | Watcharr Docs - + diff --git a/docs/category/server-configuration.html b/docs/category/server-configuration.html index bb780b42..f29e34da 100644 --- a/docs/category/server-configuration.html +++ b/docs/category/server-configuration.html @@ -4,7 +4,7 @@ Server Configuration | Watcharr Docs - + diff --git a/docs/category/usage.html b/docs/category/usage.html index 6ec05da1..f08d0919 100644 --- a/docs/category/usage.html +++ b/docs/category/usage.html @@ -4,7 +4,7 @@ Usage | Watcharr Docs - + diff --git a/docs/importing/myanimelist.html b/docs/importing/myanimelist.html index a1042fd7..dd55b0d8 100644 --- a/docs/importing/myanimelist.html +++ b/docs/importing/myanimelist.html @@ -4,7 +4,7 @@ MyAnimeList | Watcharr Docs - + diff --git a/docs/importing/text-file.html b/docs/importing/text-file.html index 6df02d81..67c4b64c 100644 --- a/docs/importing/text-file.html +++ b/docs/importing/text-file.html @@ -4,7 +4,7 @@ Text File (.txt list) | Watcharr Docs - + diff --git a/docs/importing/trakt.html b/docs/importing/trakt.html index cf9aaffd..af28a09a 100644 --- a/docs/importing/trakt.html +++ b/docs/importing/trakt.html @@ -4,7 +4,7 @@ Trakt | Watcharr Docs - + diff --git a/docs/importing/watcharr.html b/docs/importing/watcharr.html index 79509b93..341a1c27 100644 --- a/docs/importing/watcharr.html +++ b/docs/importing/watcharr.html @@ -4,7 +4,7 @@ Watcharr | Watcharr Docs - + diff --git a/docs/installation/docker-compose.html b/docs/installation/docker-compose.html index 91997a94..97a7a697 100644 --- a/docs/installation/docker-compose.html +++ b/docs/installation/docker-compose.html @@ -4,7 +4,7 @@ Docker Compose | Watcharr Docs - + diff --git a/docs/installation/for-development.html b/docs/installation/for-development.html index ce1e8b1e..28d576cd 100644 --- a/docs/installation/for-development.html +++ b/docs/installation/for-development.html @@ -4,7 +4,7 @@ For Development | Watcharr Docs - + @@ -22,7 +22,7 @@

Fork button

  • -

    Get the code by cloning your fork

    +

    Get the code by cloning your fork (edit the command and replace <your username> with your GitHub username or replace the whole url with the correct one pointing to your fork).

    git clone https://github.com/<your username>/Watcharr.git && \
    cd Watcharr
    • @@ -34,20 +34,21 @@ 
    npm i
  • -

    Install server dependencies (in the server folder)

    +

    Install server dependencies (in the server folder). Go does this automatically if you try starting the server and it notices you don't have them.

    go get .

    • Running The Code​

    To run the code, you will need to open up two terminals, one for the frontend and the other for the backend.

    +

    We have Makefiles for the frontend and server, so you can simply call make in each directory. Most Linux distros (as far as I know) include make, so you don't need to install anything. If you don't have make, you can either install it (lookup how to get "GNU Make" for your specific OS) OR you can just look inside the Makefiles and manually run the first command in each.

    1. Run the frontend (first terminal, in the project root folder)

      -
      npm run dev
      +
      make
    2. -

      Run the server (second terminal, in the project root folder)

      -
      npm run server
      +

      Run the server (second terminal, in the server folder)

      +
      make

      Note: If you're using Windows, running the server can be a little more complicated. You can follow this: https://github.com/sbondCo/Watcharr/discussions/430#discussioncomment-8894110 which amounts to these steps (the first 3 steps only need to be done once):

      1. diff --git a/docs/installation/from-source.html b/docs/installation/from-source.html index 31527eb1..5e900bfe 100644 --- a/docs/installation/from-source.html +++ b/docs/installation/from-source.html @@ -4,7 +4,7 @@ From Source | Watcharr Docs - + diff --git a/docs/introduction.html b/docs/introduction.html index 721da587..1b92a96f 100644 --- a/docs/introduction.html +++ b/docs/introduction.html @@ -4,7 +4,7 @@ Introduction | Watcharr Docs - + diff --git a/docs/server_config/backup.html b/docs/server_config/backup.html index aa0661e7..da4b2f03 100644 --- a/docs/server_config/backup.html +++ b/docs/server_config/backup.html @@ -4,7 +4,7 @@ Backing Up | Watcharr Docs - + diff --git a/docs/server_config/environment-variables.html b/docs/server_config/environment-variables.html index b9bab82e..c3e9a30c 100644 --- a/docs/server_config/environment-variables.html +++ b/docs/server_config/environment-variables.html @@ -4,7 +4,7 @@ Environment Variables | Watcharr Docs - + diff --git a/docs/server_config/game-support-igdb.html b/docs/server_config/game-support-igdb.html index 2a49656c..e8b0909c 100644 --- a/docs/server_config/game-support-igdb.html +++ b/docs/server_config/game-support-igdb.html @@ -4,7 +4,7 @@ Games Support (via IGDB/Twitch) | Watcharr Docs - + diff --git a/docs/server_config/jellyfin-auth.html b/docs/server_config/jellyfin-auth.html index 3cdb2d2d..8301ceb9 100644 --- a/docs/server_config/jellyfin-auth.html +++ b/docs/server_config/jellyfin-auth.html @@ -4,7 +4,7 @@ Jellyfin Authentication | Watcharr Docs - + diff --git a/docs/server_config/plex-auth.html b/docs/server_config/plex-auth.html index 8c1cd653..39085760 100644 --- a/docs/server_config/plex-auth.html +++ b/docs/server_config/plex-auth.html @@ -4,7 +4,7 @@ Plex Authentication | Watcharr Docs - + diff --git a/docs/server_config/restoring-admin.html b/docs/server_config/restoring-admin.html index d8b2955d..c46a1894 100644 --- a/docs/server_config/restoring-admin.html +++ b/docs/server_config/restoring-admin.html @@ -4,7 +4,7 @@ Restoring Admin Priviliges | Watcharr Docs - + diff --git a/docs/usage/adding-to-watchlist.html b/docs/usage/adding-to-watchlist.html index 2d8b5be6..18b4e4fb 100644 --- a/docs/usage/adding-to-watchlist.html +++ b/docs/usage/adding-to-watchlist.html @@ -4,7 +4,7 @@ Adding To Your Watchlist | Watcharr Docs - + diff --git a/index.html b/index.html index 052aab31..34183667 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ Watcharr Docs - + diff --git a/markdown-page.html b/markdown-page.html index d95e8b91..0a64fcef 100644 --- a/markdown-page.html +++ b/markdown-page.html @@ -4,7 +4,7 @@ Markdown page example | Watcharr Docs - +