Skip to content

README.md

Latest commit

 

History

History
45 lines (30 loc) · 1.56 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.56 KB
Raw

Discord embed server

Greenkeeper badge

Server for hosting Discord embeds.

Tools

  • Typescript - ensures everything is typed, allowing for effortless maintenance.
  • GraphQL - for static data requests
  • Socket.IO - for realtime requests
  • prettier - for code formatting

Setting up

  • copy config.example.yml to config.yml
  • edit the file as needed

When you can't use config.yml (e.g. when using automatic deployments) then you can also set some settings through environment variables:

ADMIN_IDS=…          # comma-separated list of user IDs who are admins of the bot
DISCORD_TOKEN=…      # your Discord Bot's Token
JWT_SIGNATURE_KEY=…  # add long random string here for some encryption (KEEP IT SECRET!)
LOG_CHANNEL_ID=…     # ID of the channel to send the server status messages to
LOG_SERVER_ID=…      # ID of the server to send the server status messages to

Starting

# Install dependencies
yarn

# Start app
yarn start

Once you've done that, an API server will be running on localhost:7000. You can then start the embed repo.

Testing

Cross-browser testing proudly sponsered by BrowserStack

[BrowserStack Logo](https://browserstack.com