Skip to content

Latest commit

 

History

History
105 lines (65 loc) · 2.4 KB

README.md

File metadata and controls

105 lines (65 loc) · 2.4 KB

Ultra Uniq Discord Bot

Our goal with this bot is to allow users of our Blockchain to easily bind Uniq Factories against Discord Roles.

Which allows for users of Discord to bind their Discord Account to the Ultra Blockchain.

Upon connecting their account to this bot it will then periodically update roles for a user based on what roles have bindings with a uniq factory.

Read More...

Read About Client...

Read About Server...


⚙️ Prerequisites


🚀 Setup

Clone the repository

git clone https://github.com/ultraio/ultra-discord-uniq-roles-bot

Navigate into the newly created folder

cd ultra-discord-uniq-roles-bot

Install npm packages

npm install

Create an .env file in the root repository folder by copying the .env.example.

Fill it out with the environment variable information.

See the Environment Variables section for more info.

See the Discord Bot Setup to deploy your bot.

DISCORD_BOT_TOKEN=
APPLICATION_ID=
GUILD_ID=
WEBSERVER_PORT=3000
CNAME=localhost
SIGNING_CNAME=https://discord.ultra.io/
MONGODB_URL=mongodb://USERNAME:PASSWORD@HOST
SINGLE_USER_REFRESH_INTERVAL_MS=50
DATABASE_NAME=UltraUniqLinks

🏁 Start the Bot

Depending on your environment and usecase you will want to use one of the following commands to start the bot.

Production

Builds the Server, then Starts the Bot. Uses .env values

npm run start

Development

Use this if you are making changes.

Ultra Wallet requires an HTTP(s) server to work with it.

This starts the server and uses default values for config instead of .env

Development mode may require you to run your own version of client for message signing. Read About Client... instead of default one provided in .env.example under SIGNING_CNAME.

npm run dev

Docker

These are general purpose docker instructions based off this repository.

Start by creating your .env at repository root (near the Dockerfile)

Run the following to start the bot.

docker build -t uniqbot .
docker compose up