17 lines
No EOL
23 KiB
HTML
17 lines
No EOL
23 KiB
HTML
<!doctype html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta name="generator" content="Docusaurus v2.0.0-beta.4">
|
|
<title data-react-helmet="true">Setting up | Llama Bot Documentation</title><meta data-react-helmet="true" property="og:url" content="https://llama-bot.github.io/llama-bot-docs/docs/api/setting-up"><meta data-react-helmet="true" name="docusaurus_locale" content="en"><meta data-react-helmet="true" name="docusaurus_version" content="current"><meta data-react-helmet="true" name="docusaurus_tag" content="docs-default-current"><meta data-react-helmet="true" property="og:title" content="Setting up | Llama Bot Documentation"><meta data-react-helmet="true" name="description" content="This page will teach you how to set up the Llama bot web API."><meta data-react-helmet="true" property="og:description" content="This page will teach you how to set up the Llama bot web API."><link data-react-helmet="true" rel="shortcut icon" href="/llama-bot-docs/img/logo.png"><link data-react-helmet="true" rel="canonical" href="https://llama-bot.github.io/llama-bot-docs/docs/api/setting-up"><link data-react-helmet="true" rel="alternate" href="https://llama-bot.github.io/llama-bot-docs/docs/api/setting-up" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://llama-bot.github.io/llama-bot-docs/docs/api/setting-up" hreflang="x-default"><link rel="stylesheet" href="/llama-bot-docs/assets/css/styles.b121cd8c.css">
|
|
<link rel="preload" href="/llama-bot-docs/assets/js/runtime~main.ff5de815.js" as="script">
|
|
<link rel="preload" href="/llama-bot-docs/assets/js/main.6c2fce67.js" as="script">
|
|
</head>
|
|
<body>
|
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
|
|
<div><a href="#" class="skipToContent_1oUP">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/llama-bot-docs/"><img src="/llama-bot-docs/img/logo.png" alt="Llama Bot Logo" class="themedImage_1VuW themedImage--light_3UqQ navbar__logo"><img src="/llama-bot-docs/img/logo.png" alt="Llama Bot Logo" class="themedImage_1VuW themedImage--dark_hz6m navbar__logo"><b class="navbar__title">Llama Bot</b></a><a class="navbar__item navbar__link navbar__link--active" href="/llama-bot-docs/docs/intro">Docs</a><a class="navbar__item navbar__link navbar__link--active" href="/llama-bot-docs/docs/bot/overview">Bot</a><a class="navbar__item navbar__link navbar__link--active" href="/llama-bot-docs/docs/api/overview">API</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/llama-bot/llama-bot-docs" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_3J9K"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="react-toggle toggle_3Zt9 react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_71bT">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_71bT">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_31aa"><button class="clean-btn backToTopButton_35hR" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_3Kbt"><div class="sidebar_15mo"><nav class="menu thin-scrollbar menu_Bmed menuWithAnnouncementBar_2WvA"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/llama-bot-docs/docs/intro">Intro</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Usage</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Bot</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">API</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/llama-bot-docs/docs/api/overview">Overview</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/llama-bot-docs/docs/api/setting-up">Setting up</a></li></ul></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Web Interface</a></li></ul></nav></div></aside><main class="docMainContainer_3ufF"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_3FnS"><div class="docItemContainer_33ec"><article><div class="tocCollapsible_1PrD tocMobile_3Hoh"><button type="button" class="clean-btn tocCollapsibleButton_2O1e">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_27L5">Setting up</h1></header><p>This page will teach you how to set up the <a href="https://github.com/llama-bot/llama-bot-web-api" target="_blank" rel="noopener noreferrer">Llama bot web API</a>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="steps"></a>Steps<a class="hash-link" href="#steps" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="pre-requirements"></a>Pre-requirements<a class="hash-link" href="#pre-requirements" title="Direct link to heading">#</a></h3><ul><li><a href="https://nodejs.org" target="_blank" rel="noopener noreferrer">Node.js</a> version 14 or greater</li><li>Discord account</li><li>Google Firebase account</li></ul><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="discord"></a>Discord<a class="hash-link" href="#discord" title="Direct link to heading">#</a></h3><ol><li><p>Go to the <a href="https://discord.com/developers/applications" target="_blank" rel="noopener noreferrer">Discord Developer Portal</a> and create an application. Select one if you already have it. Using the same application used by the discord bot is recommended.</p></li><li><p>Go to the OAuth2 tab.</p></li><li><p>Add the following redirect URIs:</p><ul><li><p>localhost for testing</p><ul><li><code>http://localhost:5001/<project-id>/us-central1/api</code></li><li><code>http://localhost:5001/<project-id>/us-central1/api/auth</code></li></ul></li><li><p>http</p><ul><li><code>http://us-central1-<project-id>.cloudfunctions.net/api</code></li><li><code>http://us-central1-<project-id>.cloudfunctions.net/api/auth</code></li></ul></li><li><p>https</p><ul><li><code>https://us-central1-<project-id>.cloudfunctions.net/api</code></li><li><code>https://us-central1-<project-id>.cloudfunctions.net/api/auth</code></li></ul></li></ul></li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="firebase"></a>Firebase<a class="hash-link" href="#firebase" title="Direct link to heading">#</a></h3><ul><li>must be the same project that the llama bot is using</li></ul><ol><li><p>Create a firebase project.</p><p><a href="https://console.firebase.google.com" target="_blank" rel="noopener noreferrer">https://console.firebase.google.com</a></p></li><li><p>Create/Select a project. Make sure it is using the <a href="https://firebase.google.com/pricing" target="_blank" rel="noopener noreferrer">blaze plan</a>.</p></li><li><p>Go to the <code>Authentication</code> tab and enable <code>Email/Password</code> Authentication.</p></li><li><p>Go to the <code>Firestore Database</code> tab and enable it (using production mode is highly recommended).</p></li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="local"></a>Local<a class="hash-link" href="#local" title="Direct link to heading">#</a></h3><ol><li><p>Clone the <a href="https://github.com/llama-bot/llama-bot-web-api" target="_blank" rel="noopener noreferrer">llama-bot-web-api</a> repository</p><p>Using HTTPS</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">git</span><span class="token plain"> clone https://github.com/llama-bot/llama-bot-web-api.git</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><p>Using SSH:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">git</span><span class="token plain"> clone git@github.com:llama-bot/llama-bot-web-api.git</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Create <code>functions/src/config.json</code> and fill in the data.</p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">functions/src/config.json</div><div class="codeBlockContent_hGly json"><pre tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"region"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"FIREBASE_FUNCTIONS_REGION_HERE"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Region where firebase functions is hosted in. Example: us-central1</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"scopes"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"DISCORD"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"SCOPES"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"HERE"</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Discord OAuth2 scopes. Example: ["identify", "email"]</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Create <code>functions/src/secret.json</code> and fill in the data.</p><div class="codeBlockContainer_K1bP"><div style="color:#393A34;background-color:#f6f8fa" class="codeBlockTitle_eoMF">functions/src/secret.json</div><div class="codeBlockContent_hGly json"><pre tabindex="0" class="prism-code language-json codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"projectID"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"FIREBASE_PROJECT_ID_HERE"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Firebase project ID</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"clientID"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"DISCORD_CLIENT_ID_HERE"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Discord OAuth2 Client ID</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"clientSecret"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"DISCORD_CLIENT_SECRET_HERE"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Discord OAuth2 Client Secret</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"secret"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"SECRET_COOKIE_KEY_HERE"</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// secret to be used for express session</span><span class="token plain"></span></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Install firebase cli tools.</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> -g firebase-tools</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Select firebase project</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token plain">firebase use </span><span class="token operator" style="color:#393A34"><</span><span class="token plain">firebase-project-id</span><span class="token operator" style="color:#393A34">></span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Go to <code>functions</code> directory and install necessary dependencies.</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li></ol><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="testing"></a>Testing<a class="hash-link" href="#testing" title="Direct link to heading">#</a></h2><ol><li><p>Start local test server by running the following command:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> run serve</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div></li><li><p>Open locally served API and log in with your discord account.</p><div class="admonition admonition-warning alert alert--danger"><div class="admonition-heading"><h5><span class="admonition-icon"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="16" viewBox="0 0 12 16"><path fill-rule="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"></path></svg></span>warning</h5></div><div class="admonition-content"><p>HTTP<strong>S</strong> won't work when serving locally. Use HTTP instead.</p></div></div><p>Login test URI: <code>http://localhost:5001/<FIREBASE-PROJECT-ID>/us-central1/api/login</code></p></li><li><p>If everything is set up correctly, this should have added a new user that you can check it in the firebase <code>Authentication</code> tab.</p></li></ol><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="deploying"></a>Deploying<a class="hash-link" href="#deploying" title="Direct link to heading">#</a></h3><p>Deploying the functions to production is as simple as running the following command:</p><div class="codeBlockContainer_K1bP"><div class="codeBlockContent_hGly bash"><pre tabindex="0" class="prism-code language-bash codeBlock_23N8 thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_39YC"><span class="token-line" style="color:#393A34"><span class="token plain">firebase deploy</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_Ue-o clean-btn">Copy</button></div></div><p>Production API URI: <code>https://us-central1-<firebase-project-id>.cloudfunctions.net/api</code>.</p><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_2LWZ" id="more-info"></a>More info<a class="hash-link" href="#more-info" title="Direct link to heading">#</a></h2><ul><li>discord developers documentation: <a href="https://discord.com/developers/docs" target="_blank" rel="noopener noreferrer">https://discord.com/developers/docs</a></li><li>firebase admin sdk documentation: <a href="https://firebase.google.com/docs" target="_blank" rel="noopener noreferrer">https://firebase.google.com/docs</a></li></ul></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/facebook/docusaurus/edit/master/website/docs/4-api/2-setting-up.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_2_ui" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_3DPF"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/llama-bot-docs/docs/api/overview"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Overview</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/llama-bot-docs/docs/web-interface/overview"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Overview »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_35-E thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#steps" class="table-of-contents__link">Steps</a><ul><li><a href="#pre-requirements" class="table-of-contents__link">Pre-requirements</a></li><li><a href="#discord" class="table-of-contents__link">Discord</a></li><li><a href="#firebase" class="table-of-contents__link">Firebase</a></li><li><a href="#local" class="table-of-contents__link">Local</a></li></ul></li><li><a href="#testing" class="table-of-contents__link">Testing</a><ul><li><a href="#deploying" class="table-of-contents__link">Deploying</a></li></ul></li><li><a href="#more-info" class="table-of-contents__link">More info</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="footer__bottom text--center"><div class="footer__copyright">Created by <b>developomp</b>. Built with <a href="https://github.com/facebook/docusaurus">Docusaurus</a>.</div></div></div></footer></div>
|
|
<script src="/llama-bot-docs/assets/js/runtime~main.ff5de815.js"></script>
|
|
<script src="/llama-bot-docs/assets/js/main.6c2fce67.js"></script>
|
|
</body>
|
|
</html> |