Skip to content

README.md

Latest commit

 

History

History
46 lines (37 loc) · 2.48 KB

README.md

File metadata and controls

46 lines (37 loc) · 2.48 KB

BDO_Guild_Manager

A discord integrated guild manager to handle gear and stat tracking

Getting Started

Installing For Production

  1. Set up a Discord Bot
  2. Get a Gyazo API Key
  3. Get an Imgur API ID
  4. Create a Google Cloud account
  5. Create a Google Sheet for external rostering [Optional]
  6. Select a host for your app
  7. Clone this repository to your host
  8. Test the bot with one of the available Commands

Setting up the Environment

After you deploy this application to it's hosted location, you'll need to set up some environment variables. Every hosting provider has SOME way of defining environment variables. If you went with the Heroku option that we suggested, you'll do this in your app's settings tab under the Config Vars section.

Once you've found where this can be done, then start Seting up the production environment

Installing For Development

This repository uses normal git flows, if you need a refresher on using git you can find it here

  1. Set up a Discord Bot
  2. Get a Gyazo API Key
  3. Get an Imgur API ID
  4. Create a Google Cloud account
  5. Create a Google Sheet for external rostering [Optional]
  6. Clone this repository to your computer

Setting up the Environment

  • This project needs some secrets that will be stored in a .env file.
  • To create, cd to the base of this project generally cd BDO_Guild_Manager and touch .env

Once you've created a .env file, add entries for all of the required variables from here.

  • For the database options, docker-compose will handle most of the options for you, you only need to supply the following:
    • DB_PASS: SuperSecurePassword123

Once these steps have been completed: head on over to Using docker-compose

Need help?