diff --git a/404.html b/404.html index 4f48834..0f12dbc 100644 --- a/404.html +++ b/404.html @@ -5,13 +5,13 @@ Page Not Found | Llama Bot Documentation - +
Skip to main content

Page Not Found

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.

- + \ No newline at end of file diff --git a/assets/js/8a441d9e.82a9f7c8.js b/assets/js/8a441d9e.82a9f7c8.js new file mode 100644 index 0000000..20e516e --- /dev/null +++ b/assets/js/8a441d9e.82a9f7c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkllama_bot_docs=self.webpackChunkllama_bot_docs||[]).push([[37],{6256:function(t,e,i){i.r(e),i.d(e,{frontMatter:function(){return s},contentTitle:function(){return l},metadata:function(){return u},toc:function(){return d},default:function(){return c}});var n=i(7462),a=i(3366),o=(i(7294),i(3905)),r=["components"],s={sidebar_position:1},l="Overview",u={unversionedId:"api/overview",id:"api/overview",isDocsHomePage:!1,title:"Overview",description:"Firebase http API for the llama bot.",source:"@site/docs/4-api/1-overview.md",sourceDirName:"4-api",slug:"/api/overview",permalink:"/llama-bot-docs/docs/api/overview",editUrl:"https://github.com/facebook/docusaurus/edit/master/website/docs/4-api/1-overview.md",version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Setting up",permalink:"/llama-bot-docs/docs/bot/setting-up"},next:{title:"Setting up",permalink:"/llama-bot-docs/docs/api/setting-up"}},d=[{value:"Endpoints",id:"endpoints",children:[{value:"Auhentication",id:"auhentication",children:[]},{value:"REST",id:"rest",children:[]}]},{value:"Special thanks",id:"special-thanks",children:[]}],p={toc:d};function c(t){var e=t.components,i=(0,a.Z)(t,r);return(0,o.kt)("wrapper",(0,n.Z)({},p,i,{components:e,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"overview"},"Overview"),(0,o.kt)("p",null,"Firebase http API for the ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot"},"llama bot"),"."),(0,o.kt)("h2",{id:"endpoints"},"Endpoints"),(0,o.kt)("h3",{id:"auhentication"},"Auhentication"),(0,o.kt)("h4",{id:"login"},(0,o.kt)("inlineCode",{parentName:"h4"},"/login")),(0,o.kt)("p",null,"Login using discord OAuth2"),(0,o.kt)("h4",{id:"logout"},(0,o.kt)("inlineCode",{parentName:"h4"},"/logout")),(0,o.kt)("p",null,"Logout from account"),(0,o.kt)("h4",{id:"auth"},(0,o.kt)("inlineCode",{parentName:"h4"},"/auth")),(0,o.kt)("p",null,"Discord OAuth2 callback"),(0,o.kt)("h3",{id:"rest"},"REST"),(0,o.kt)("h4",{id:"usersnew"},(0,o.kt)("inlineCode",{parentName:"h4"},"/users/new")),(0,o.kt)("p",null,"Create a new user"),(0,o.kt)("h4",{id:"usersfind"},(0,o.kt)("inlineCode",{parentName:"h4"},"/users/find")),(0,o.kt)("p",null,"Find a user"),(0,o.kt)("h4",{id:"users"},(0,o.kt)("inlineCode",{parentName:"h4"},"/users")),(0,o.kt)("p",null,"List all users in the database"),(0,o.kt)("h4",{id:"list-servers"},(0,o.kt)("inlineCode",{parentName:"h4"},"/list-servers")),(0,o.kt)("p",null,"List all servers in the database"),(0,o.kt)("h2",{id:"special-thanks"},"Special thanks"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://github.com/luizkc"},"luizkc")," for discord oauth2 authentication (",(0,o.kt)("a",{parentName:"li",href:"https://github.com/luizkc/firebase-discord-oauth2-example"},"repo"),")")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8a441d9e.c368be74.js b/assets/js/8a441d9e.c368be74.js deleted file mode 100644 index b946d4d..0000000 --- a/assets/js/8a441d9e.c368be74.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkllama_bot_docs=self.webpackChunkllama_bot_docs||[]).push([[37],{6256:function(e,t,i){i.r(t),i.d(t,{frontMatter:function(){return s},contentTitle:function(){return u},metadata:function(){return d},toc:function(){return l},default:function(){return p}});var n=i(7462),o=i(3366),r=(i(7294),i(3905)),a=["components"],s={sidebar_position:1},u="Overview",d={unversionedId:"api/overview",id:"api/overview",isDocsHomePage:!1,title:"Overview",description:"For web interface",source:"@site/docs/4-api/1-overview.md",sourceDirName:"4-api",slug:"/api/overview",permalink:"/llama-bot-docs/docs/api/overview",editUrl:"https://github.com/facebook/docusaurus/edit/master/website/docs/4-api/1-overview.md",version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Setting up",permalink:"/llama-bot-docs/docs/bot/setting-up"},next:{title:"Setting up",permalink:"/llama-bot-docs/docs/api/setting-up"}},l=[{value:"Endpoints",id:"endpoints",children:[{value:"Auhentication",id:"auhentication",children:[]},{value:"REST",id:"rest",children:[]}]}],c={toc:l};function p(e){var t=e.components,i=(0,o.Z)(e,a);return(0,r.kt)("wrapper",(0,n.Z)({},c,i,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"overview"},"Overview"),(0,r.kt)("p",null,"For web interface"),(0,r.kt)("h2",{id:"endpoints"},"Endpoints"),(0,r.kt)("h3",{id:"auhentication"},"Auhentication"),(0,r.kt)("h4",{id:"login"},(0,r.kt)("inlineCode",{parentName:"h4"},"/login")),(0,r.kt)("p",null,"Login using discord OAuth2"),(0,r.kt)("h4",{id:"logout"},(0,r.kt)("inlineCode",{parentName:"h4"},"/logout")),(0,r.kt)("p",null,"Logout from account"),(0,r.kt)("h4",{id:"auth"},(0,r.kt)("inlineCode",{parentName:"h4"},"/auth")),(0,r.kt)("p",null,"Discord OAuth2 callback"),(0,r.kt)("h3",{id:"rest"},"REST"),(0,r.kt)("h4",{id:"usersnew"},(0,r.kt)("inlineCode",{parentName:"h4"},"/users/new")),(0,r.kt)("p",null,"Create a new user"),(0,r.kt)("h4",{id:"usersfind"},(0,r.kt)("inlineCode",{parentName:"h4"},"/users/find")),(0,r.kt)("p",null,"Find a user"),(0,r.kt)("h4",{id:"users"},(0,r.kt)("inlineCode",{parentName:"h4"},"/users")),(0,r.kt)("p",null,"List all users in the database"),(0,r.kt)("h4",{id:"list-servers"},(0,r.kt)("inlineCode",{parentName:"h4"},"/list-servers")),(0,r.kt)("p",null,"List all servers in the database"))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c6810bfd.0ca23e84.js b/assets/js/c6810bfd.0ca23e84.js deleted file mode 100644 index a0cc273..0000000 --- a/assets/js/c6810bfd.0ca23e84.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkllama_bot_docs=self.webpackChunkllama_bot_docs||[]).push([[121],{3098:function(t,e,a){a.r(e),a.d(e,{frontMatter:function(){return l},contentTitle:function(){return s},metadata:function(){return p},toc:function(){return m},default:function(){return d}});var o=a(7462),n=a(3366),i=(a(7294),a(3905)),r=["components"],l={sidebar_position:1},s="Intro",p={unversionedId:"intro",id:"intro",isDocsHomePage:!1,title:"Intro",description:"This documentation is for developers.",source:"@site/docs/1-intro.md",sourceDirName:".",slug:"/intro",permalink:"/llama-bot-docs/docs/intro",editUrl:"https://github.com/facebook/docusaurus/edit/master/website/docs/1-intro.md",version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Overview",permalink:"/llama-bot-docs/docs/usage/overview"}},m=[{value:"Discord Bot",id:"discord-bot",children:[]},{value:"API",id:"api",children:[]},{value:"Web interface",id:"web-interface",children:[]},{value:"Documentation",id:"documentation",children:[]},{value:"Special thanks",id:"special-thanks",children:[]}],c={toc:m};function d(t){var e=t.components,l=(0,n.Z)(t,r);return(0,i.kt)("wrapper",(0,o.Z)({},c,l,{components:e,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"intro"},"Intro"),(0,i.kt)("div",{className:"admonition admonition-info alert alert--info"},(0,i.kt)("div",{parentName:"div",className:"admonition-heading"},(0,i.kt)("h5",{parentName:"div"},(0,i.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,i.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,i.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))),"info")),(0,i.kt)("div",{parentName:"div",className:"admonition-content"},(0,i.kt)("p",{parentName:"div"},"This documentation is for ",(0,i.kt)("strong",{parentName:"p"},"developers"),".",(0,i.kt)("br",null),"\nIf you are a user and only want to learn how to use it, go to the ",(0,i.kt)("a",{parentName:"p",href:"/docs/usage/overview"},(0,i.kt)("strong",{parentName:"a"},"Usage"))," section."))),(0,i.kt)("p",null,"The purpose of this introduction is to help developers learn how the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/developomp/llama-bot"},"Llama Bot")," works in ",(0,i.kt)("strong",{parentName:"p"},"less than 5 minutes"),"."),(0,i.kt)("p",null,"If you have a question or a suggestion, feel free to open a issue on the appropriate repository.",(0,i.kt)("br",null),"\nA list of all repositories can be found ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot"},"here"),"."),(0,i.kt)("h2",{id:"discord-bot"},"Discord Bot"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot"},"https://github.com/llama-bot/llama-bot")),(0,i.kt)("p",null,'The "main" repository. The discord bot itself.'),(0,i.kt)("h2",{id:"api"},"API"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-web-api"},"https://github.com/llama-bot/llama-bot-web-api")),(0,i.kt)("p",null,"firebase functions http endpoints."),(0,i.kt)("h2",{id:"web-interface"},"Web interface"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-web-interface"},"https://github.com/llama-bot/llama-bot-web-interface")),(0,i.kt)("h2",{id:"documentation"},"Documentation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-docs"},"https://github.com/llama-bot/llama-bot-docs")),(0,i.kt)("p",null,"What you are reading right now."),(0,i.kt)("h2",{id:"special-thanks"},"Special thanks"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"Davidisacookie#9888 (265697563280146433)")," for making the ",(0,i.kt)("a",{target:"_blank",href:a(7880).Z},"colored bot logo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"S\u026a\u029f\u1d0b S\u1d18\u026a\u1d05\u1d07\u0280#8364 (419184817368858644)")," for making the ",(0,i.kt)("a",{target:"_blank",href:a(2902).Z},"white bot logo"))))}d.isMDXComponent=!0},2902:function(t,e,a){e.Z=a.p+"assets/files/logo-white-51789537c8931ae573310b07ba9d2a1f.png"},7880:function(t,e,a){e.Z=a.p+"assets/files/logo-90099698768c2436142ce09eb40fbafb.png"}}]); \ No newline at end of file diff --git a/assets/js/c6810bfd.658b143d.js b/assets/js/c6810bfd.658b143d.js new file mode 100644 index 0000000..fa6a912 --- /dev/null +++ b/assets/js/c6810bfd.658b143d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkllama_bot_docs=self.webpackChunkllama_bot_docs||[]).push([[121],{3098:function(t,e,a){a.r(e),a.d(e,{frontMatter:function(){return l},contentTitle:function(){return s},metadata:function(){return p},toc:function(){return m},default:function(){return c}});var o=a(7462),n=a(3366),i=(a(7294),a(3905)),r=["components"],l={sidebar_position:1},s="Intro",p={unversionedId:"intro",id:"intro",isDocsHomePage:!1,title:"Intro",description:"UNDER DEVELOPMENT. Not even pre-alpha",source:"@site/docs/1-intro.md",sourceDirName:".",slug:"/intro",permalink:"/llama-bot-docs/docs/intro",editUrl:"https://github.com/facebook/docusaurus/edit/master/website/docs/1-intro.md",version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Overview",permalink:"/llama-bot-docs/docs/usage/overview"}},m=[{value:"Discord Bot",id:"discord-bot",children:[]},{value:"API",id:"api",children:[]},{value:"Web interface",id:"web-interface",children:[]},{value:"Documentation",id:"documentation",children:[]},{value:"Special thanks",id:"special-thanks",children:[]}],d={toc:m};function c(t){var e=t.components,l=(0,n.Z)(t,r);return(0,i.kt)("wrapper",(0,o.Z)({},d,l,{components:e,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"intro"},"Intro"),(0,i.kt)("div",{className:"admonition admonition-warning alert alert--danger"},(0,i.kt)("div",{parentName:"div",className:"admonition-heading"},(0,i.kt)("h5",{parentName:"div"},(0,i.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,i.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"12",height:"16",viewBox:"0 0 12 16"},(0,i.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"}))),"warning")),(0,i.kt)("div",{parentName:"div",className:"admonition-content"},(0,i.kt)("p",{parentName:"div"},(0,i.kt)("strong",{parentName:"p"},"UNDER DEVELOPMENT. Not even pre-alpha")))),(0,i.kt)("div",{className:"admonition admonition-info alert alert--info"},(0,i.kt)("div",{parentName:"div",className:"admonition-heading"},(0,i.kt)("h5",{parentName:"div"},(0,i.kt)("span",{parentName:"h5",className:"admonition-icon"},(0,i.kt)("svg",{parentName:"span",xmlns:"http://www.w3.org/2000/svg",width:"14",height:"16",viewBox:"0 0 14 16"},(0,i.kt)("path",{parentName:"svg",fillRule:"evenodd",d:"M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"}))),"info")),(0,i.kt)("div",{parentName:"div",className:"admonition-content"},(0,i.kt)("p",{parentName:"div"},"This documentation is for ",(0,i.kt)("strong",{parentName:"p"},"developers"),".",(0,i.kt)("br",null),"\nIf you are a user and only want to learn how to use it, go to the ",(0,i.kt)("a",{parentName:"p",href:"/docs/usage/overview"},(0,i.kt)("strong",{parentName:"a"},"Usage"))," section."))),(0,i.kt)("p",null,"The purpose of this introduction is to help developers learn how the ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/developomp/llama-bot"},"Llama Bot")," works in ",(0,i.kt)("strong",{parentName:"p"},"less than 5 minutes"),"."),(0,i.kt)("p",null,"If you have a question or a suggestion, feel free to open a issue on the appropriate repository.",(0,i.kt)("br",null),"\nA list of all repositories can be found ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot"},"here"),"."),(0,i.kt)("h2",{id:"discord-bot"},"Discord Bot"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot"},"https://github.com/llama-bot/llama-bot")),(0,i.kt)("p",null,'The "main" repository. The discord bot itself.'),(0,i.kt)("h2",{id:"api"},"API"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-web-api"},"https://github.com/llama-bot/llama-bot-web-api")),(0,i.kt)("p",null,"firebase functions http endpoints."),(0,i.kt)("h2",{id:"web-interface"},"Web interface"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-web-interface"},"https://github.com/llama-bot/llama-bot-web-interface")),(0,i.kt)("h2",{id:"documentation"},"Documentation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/llama-bot/llama-bot-docs"},"https://github.com/llama-bot/llama-bot-docs")),(0,i.kt)("p",null,"What you are reading right now."),(0,i.kt)("h2",{id:"special-thanks"},"Special thanks"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"Davidisacookie#9888 (265697563280146433)")," for making the ",(0,i.kt)("a",{target:"_blank",href:a(7880).Z},"colored bot logo")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"S\u026a\u029f\u1d0b S\u1d18\u026a\u1d05\u1d07\u0280#8364 (419184817368858644)")," for making the ",(0,i.kt)("a",{target:"_blank",href:a(2902).Z},"white bot logo"))))}c.isMDXComponent=!0},2902:function(t,e,a){e.Z=a.p+"assets/files/logo-white-51789537c8931ae573310b07ba9d2a1f.png"},7880:function(t,e,a){e.Z=a.p+"assets/files/logo-90099698768c2436142ce09eb40fbafb.png"}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.ff5de815.js b/assets/js/runtime~main.e26d16a0.js similarity index 97% rename from assets/js/runtime~main.ff5de815.js rename to assets/js/runtime~main.e26d16a0.js index 24e1441..fb11eec 100644 --- a/assets/js/runtime~main.ff5de815.js +++ b/assets/js/runtime~main.e26d16a0.js @@ -1 +1 @@ -!function(){"use strict";var e,t,n,r,o,a={},u={};function c(e){var t=u[e];if(void 0!==t)return t.exports;var n=u[e]={id:e,loaded:!1,exports:{}};return a[e].call(n.exports,n,n.exports,c),n.loaded=!0,n.exports}c.m=a,c.c=u,e=[],c.O=function(t,n,r,o){if(!n){var a=1/0;for(d=0;d=o)&&Object.keys(c.O).every((function(e){return c.O[e](n[f])}))?n.splice(f--,1):(u=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},c.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return c.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var a={};t=t||[null,n({}),n([]),n(n)];for(var u=2&r&&e;"object"==typeof u&&!~t.indexOf(u);u=n(u))Object.getOwnPropertyNames(u).forEach((function(t){a[t]=function(){return e[t]}}));return a.default=function(){return e},c.d(o,a),o},c.d=function(e,t){for(var n in t)c.o(t,n)&&!c.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},c.f={},c.e=function(e){return Promise.all(Object.keys(c.f).reduce((function(t,n){return c.f[n](e,t),t}),[]))},c.u=function(e){return"assets/js/"+({37:"8a441d9e",53:"935f2afb",54:"9dd8a0d2",85:"1f391b9e",121:"c6810bfd",335:"5f13ba2e",514:"1be78505",544:"611e23df",576:"6ec7341c",592:"common",637:"e9b15d25",685:"8c4d310d",918:"17896441",994:"d6526129"}[e]||e)+"."+{37:"c368be74",53:"f08705c5",54:"07c86e4d",85:"5add7e70",121:"0ca23e84",131:"434127c2",261:"13f5f153",335:"fc368d26",392:"d6d12b28",514:"f71f4a7b",544:"7262d5e0",576:"cc6ef657",592:"ce3e5906",608:"27d8cc09",637:"40a965ac",685:"1de429ef",918:"a6198cb6",994:"939c7f24"}[e]+".js"},c.miniCssF=function(e){return"assets/css/styles.b121cd8c.css"},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="llama-bot-docs:",c.l=function(e,t,n,a){if(r[e])r[e].push(t);else{var u,f;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d=o)&&Object.keys(c.O).every((function(e){return c.O[e](n[f])}))?n.splice(f--,1):(u=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[n,r,o]},c.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return c.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},c.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var a={};t=t||[null,n({}),n([]),n(n)];for(var u=2&r&&e;"object"==typeof u&&!~t.indexOf(u);u=n(u))Object.getOwnPropertyNames(u).forEach((function(t){a[t]=function(){return e[t]}}));return a.default=function(){return e},c.d(o,a),o},c.d=function(e,t){for(var n in t)c.o(t,n)&&!c.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},c.f={},c.e=function(e){return Promise.all(Object.keys(c.f).reduce((function(t,n){return c.f[n](e,t),t}),[]))},c.u=function(e){return"assets/js/"+({37:"8a441d9e",53:"935f2afb",54:"9dd8a0d2",85:"1f391b9e",121:"c6810bfd",335:"5f13ba2e",514:"1be78505",544:"611e23df",576:"6ec7341c",592:"common",637:"e9b15d25",685:"8c4d310d",918:"17896441",994:"d6526129"}[e]||e)+"."+{37:"82a9f7c8",53:"f08705c5",54:"07c86e4d",85:"5add7e70",121:"658b143d",131:"434127c2",261:"13f5f153",335:"fc368d26",392:"d6d12b28",514:"f71f4a7b",544:"7262d5e0",576:"cc6ef657",592:"ce3e5906",608:"27d8cc09",637:"40a965ac",685:"1de429ef",918:"a6198cb6",994:"939c7f24"}[e]+".js"},c.miniCssF=function(e){return"assets/css/styles.b121cd8c.css"},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},o="llama-bot-docs:",c.l=function(e,t,n,a){if(r[e])r[e].push(t);else{var u,f;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d -Overview | Llama Bot Documentation - +Overview | Llama Bot Documentation +
-

Overview

For web interface

Endpoints#

Auhentication#

/login#

Login using discord OAuth2

/logout#

Logout from account

/auth#

Discord OAuth2 callback

REST#

/users/new#

Create a new user

/users/find#

Find a user

/users#

List all users in the database

/list-servers#

List all servers in the database

- +

Overview

Firebase http API for the llama bot.

Endpoints#

Auhentication#

/login#

Login using discord OAuth2

/logout#

Logout from account

/auth#

Discord OAuth2 callback

REST#

/users/new#

Create a new user

/users/find#

Find a user

/users#

List all users in the database

/list-servers#

List all servers in the database

Special thanks#

+ \ No newline at end of file diff --git a/docs/api/setting-up.html b/docs/api/setting-up.html index 8c48892..493fbc9 100644 --- a/docs/api/setting-up.html +++ b/docs/api/setting-up.html @@ -5,13 +5,13 @@ Setting up | Llama Bot Documentation - +

Setting up

This page will teach you how to set up the Llama bot web API.

Steps#

Pre-requirements#

  • Node.js version 14 or greater
  • Discord account
  • Google Firebase account

Discord#

  1. Go to the Discord Developer Portal and create an application. Select one if you already have it. Using the same application used by the discord bot is recommended.

  2. Go to the OAuth2 tab.

  3. Add the following redirect URIs:

    • localhost for testing

      • http://localhost:5001/<project-id>/us-central1/api
      • http://localhost:5001/<project-id>/us-central1/api/auth

    • http

      • http://us-central1-<project-id>.cloudfunctions.net/api
      • http://us-central1-<project-id>.cloudfunctions.net/api/auth

    • https

      • https://us-central1-<project-id>.cloudfunctions.net/api
      • https://us-central1-<project-id>.cloudfunctions.net/api/auth

Firebase#

  • must be the same project that the llama bot is using

  1. Create a firebase project.

    https://console.firebase.google.com

  2. Create/Select a project. Make sure it is using the blaze plan.

  3. Go to the Authentication tab and enable Email/Password Authentication.

  4. Go to the Firestore Database tab and enable it (using production mode is highly recommended).

Local#

  1. Clone the llama-bot-web-api repository

    Using HTTPS

    git clone https://github.com/llama-bot/llama-bot-web-api.git

    Using SSH:

    git clone git@github.com:llama-bot/llama-bot-web-api.git

  2. Create functions/src/config.json and fill in the data.

    functions/src/config.json
    {  "region": "FIREBASE_FUNCTIONS_REGION_HERE", // Region where firebase functions is hosted in. Example: us-central1  "scopes": ["DISCORD", "SCOPES", "HERE"] // Discord OAuth2 scopes. Example: ["identify", "email"]}

  3. Create functions/src/secret.json and fill in the data.

    functions/src/secret.json
    {  "projectID": "FIREBASE_PROJECT_ID_HERE", // Firebase project ID  "clientID": "DISCORD_CLIENT_ID_HERE", // Discord OAuth2 Client ID  "clientSecret": "DISCORD_CLIENT_SECRET_HERE", // Discord OAuth2 Client Secret  "secret": "SECRET_COOKIE_KEY_HERE" // secret to be used for express session}

  4. Install firebase cli tools.

    npm install -g firebase-tools

  5. Select firebase project

    firebase use <firebase-project-id>

  6. Go to functions directory and install necessary dependencies.

    npm install

Testing#

  1. Start local test server by running the following command:

    npm run serve

  2. Open locally served API and log in with your discord account.

    warning

    HTTPS won't work when serving locally. Use HTTP instead.

    Login test URI: http://localhost:5001/<FIREBASE-PROJECT-ID>/us-central1/api/login

  3. If everything is set up correctly, this should have added a new user that you can check it in the firebase Authentication tab.

Deploying#

Deploying the functions to production is as simple as running the following command:

firebase deploy

Production API URI: https://us-central1-<firebase-project-id>.cloudfunctions.net/api.

More info#

- + \ No newline at end of file diff --git a/docs/bot/overview.html b/docs/bot/overview.html index 72a0a91..04a0a1a 100644 --- a/docs/bot/overview.html +++ b/docs/bot/overview.html @@ -5,13 +5,13 @@ Overview | Llama Bot Documentation - +
- + \ No newline at end of file diff --git a/docs/bot/setting-up.html b/docs/bot/setting-up.html index b94751d..d4a4caa 100644 --- a/docs/bot/setting-up.html +++ b/docs/bot/setting-up.html @@ -5,14 +5,14 @@ Setting up | Llama Bot Documentation - +

Setting up

This page will teach you how to set up the llama discord bot.

Result:
example image of bot usage

Steps#

Pre-requirements#

  • Python version 3.9 or greater
  • Discord account
  • Google Firebase account
  • A sacrifice to be given to the llama gods (no longer needed)

Discord#

  1. Create a new application from the Discord Developer Portal. Select one if you already have it. Be cautious though, since this operation is NOT REVERSIBLE.
  2. Make application a bot.
  3. Copy the bot token. This will be used during the Server setup.

Firebase#

  1. Create a firebase project.

    https://console.firebase.google.com

  2. Create firestore database (production mode is highly recommended).

  3. Generate and download the service account key. This will be used during the Server setup.

Server#

info

Assumes UNIX-like environment (Linux, BSD, Mac, etc.)

  1. Clone the llama bot repository and cd into it.

    git clone https://github.com/llama-bot/llama-bot.git
    cd llama-bot

  2. Install python dependencies.

    pip install -r requirements.txt

  3. Create secrets directory in the bot directory.

  4. In the secrets directory, create secret.json and put the discord bot token generated during the Discord setup.

    bot/secret.json
    {  "token": "<DISCORD_BOT_TOKEN_HERE>"}

  5. Rename firebase admin key generated during the Firebase setup to firebase-adminsdk.json, and put it in the secrets directory.

Testing#

After following all the steps, cd into the bot directory and run the following command:

python llama.py

If everything is set up correctly, this should start the bot and load all the cogs. Web Interface will not work if the API is not set up.

More info#

- + \ No newline at end of file diff --git a/docs/intro.html b/docs/intro.html index 6461450..e953284 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -4,16 +4,16 @@ -Intro | Llama Bot Documentation - +Intro | Llama Bot Documentation +
-

Intro

info

This documentation is for developers.
+

Intro

warning

UNDER DEVELOPMENT. Not even pre-alpha

info

This documentation is for developers.
If you are a user and only want to learn how to use it, go to the Usage section.

The purpose of this introduction is to help developers learn how the Llama Bot works in less than 5 minutes.

If you have a question or a suggestion, feel free to open a issue on the appropriate repository.
A list of all repositories can be found here.

Discord Bot#

https://github.com/llama-bot/llama-bot

The "main" repository. The discord bot itself.

API#

https://github.com/llama-bot/llama-bot-web-api

firebase functions http endpoints.

Web interface#

https://github.com/llama-bot/llama-bot-web-interface

Documentation#

https://github.com/llama-bot/llama-bot-docs

What you are reading right now.

Special thanks#

  • Davidisacookie#9888 (265697563280146433) for making the colored bot logo
  • SษชสŸแด‹ Sแด˜ษชแด…แด‡ส€#8364 (419184817368858644) for making the white bot logo
- + \ No newline at end of file diff --git a/docs/usage/overview.html b/docs/usage/overview.html index 65d14a8..0b2b8d0 100644 --- a/docs/usage/overview.html +++ b/docs/usage/overview.html @@ -5,13 +5,13 @@ Overview | Llama Bot Documentation - +
- + \ No newline at end of file diff --git a/docs/web-interface/overview.html b/docs/web-interface/overview.html index a061ad9..6f3c905 100644 --- a/docs/web-interface/overview.html +++ b/docs/web-interface/overview.html @@ -5,13 +5,13 @@ Overview | Llama Bot Documentation - +
- + \ No newline at end of file diff --git a/index.html b/index.html index be3f351..1b7e64f 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Llama Bot Documentation | Llama Bot Documentation - +

Llama Bot Documentation

Get started - 5min โฑ๏ธ

Open source

Everything that make up the bot can be found on Github. You can even clone and host it yourself!

102% Free

Llama bot is not just free as in free ice cream, but also free as in freedom. Every part of the bot is licensed under the MIT License so you are free to do whatever your hart desires!

Easy to use

โœ”๏ธ Simple
โœ”๏ธ Modern
โœ”๏ธ Extendable
โœ”๏ธ Well documented

- + \ No newline at end of file diff --git a/secret.html b/secret.html index 8785787..cb7365e 100644 --- a/secret.html +++ b/secret.html @@ -5,14 +5,14 @@ A hidden page | Llama Bot Documentation - +

Go back

How did you find me, why are you here?
No, this is not an easter egg.

- + \ No newline at end of file