llama-bot/llama-bot-docs
1
0
Fork 0
Code Activity
llama-bot-docs/docs/4-web-interface/2-setting-up.md

4.1 KiB
Raw Blame History

Setting up

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

Steps

Pre-requirements

  • Node.js version 14 or greater (version 16 is recommended)
  • yarn
  • Discord account
  • Google Firebase account
  • Payment method (No payment required for light usage. More info here)

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 redirects:

    • testing (http): http://localhost:5000/api/auth
    • production (https): https://<YOUR_SITE_NAME_HERE>/api/auth (e.g. https://llama.developomp.com/api/auth)

Firebase

  1. Create a firebase project. Select one if you already have it. Using the same project usd by the bot is recommended. Make sure it is using the blaze plan.
  2. Go to the Firestore Database tab and enable it. Usage of production mode is highly recommended.

Local

Clone the llama-bot-web-interface repository.

Functions

  1. Edit functions/src/config.json.

    {
  "pathPrefix": "/api", // where the API endpoints will be located. Set it to "/" if it's on another domain (example: api.example.com)
  "scopes": ["identify", "email", "guilds"] // Discord OAuth2 scopes.
}

    more info about discord OAuth2 scopes can be found in the discord developers documentation

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

    {
  "clientID": "DISCORD_CLIENT_ID_HERE", // Discord OAuth2 Client ID
  "clientSecret": "DISCORD_CLIENT_SECRET_HERE", // Discord OAuth2 Client Secret
  "secret": "SECRET_COOKIE_KEY_HERE" // secret key to be used for express session security
}

  3. Visit this link, select your firebase project and download the firebase admin sdk key by pressing the "Generate new private key" button. Rename it to firebase-adminsdk.json and put it in functions/src/.

  4. Install firebase cli tools.

    yarn global add firebase-tools

  5. Select firebase project. You may have to log in. You must run this command in the project root.

    firebase use <FIREBASE_PROJECT_ID_HERE>

  6. Go to functions directory and install necessary dependencies.

    yarn install

  7. Build production code.

    yarn build

Frontend

  1. Go to the frontend directory and install dependencies.

    yarn install

  2. Test with hot reloading.

    yarn dev

  3. Build site for production.

    yarn build

  4. Preview the production build

    yarn preview

Testing

:::info Build backend and frontend code first :::

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

    firebase serve

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

    http://localhost:5000

  3. If everything is set up correctly, this should have added a new user in firestore database.

Deployment

:::warning Make sure to test your code before deploying to production :::

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

firebase deploy

The deployment could take a while so be patient.

To deploy frontend code only:

firebase deploy --only hosting

To deploy backend code only:

firebase deploy --only functions

More info