/invidget

SVG invite widgets that look just like the ones on the Discord client!

Primary LanguageJavaScriptMIT LicenseMIT

invidget

SVG invite widgets that look just like the ones on the Discord client!

Preview

Dark theme (default)

Dark theme preview

Light theme ?theme=light

Light theme preview

Different language ?language=pt

Light theme preview

⚠ THIS PROJECT IS WIP!

Planned features

  • Unit Tests
    • Code Style
    • strings.json
      • ISO 639-1 language codes
      • Alphabetical Order
  • Generate and serve SVGs
  • Make the SVG look like the discord invite widget
  • Automatically build and push to Docker Hub through GitHub Actions
  • Watch for src changes and restart automatically for development
  • Light Theme (?theme=light)
  • Winston Logging
  • Sentry Error Reporting
  • Handle invites from servers without icons
    • Render the acronym
  • Redis Caching
  • Handle invites from servers with emojis in their names
  • Handle expired/invalid invites (do the same thing that Discord does)
  • Handle text overflow

Setting up a development environment

  • Clone this repo
  • npm install
  • Run npm run dev to get the development server up
  • Access it through http://localhost:8080/

String guidelines

  • Language codes should be in ISO 639-1 format
  • Languages should be in alphabetical order in the .json
  • If Discord supports the language you're adding, strings should perfectly match the ones on the client (capitalization too!)
  • Check if your JSON is valid