https://github.com/SwitchbladeBot/invidget

SVG invite widgets that look just like the ones on the Discord client!
https://github.com/SwitchbladeBot/invidget

discord hacktoberfest svg widgets

Last synced: 19 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/SwitchbladeBot/invidget
• Owner: SwitchbladeBot
• License: mit
• Created: 2019-06-09T15:18:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-02-02T17:27:47.000Z (10 months ago)
• Last Synced: 2024-05-27T12:10:24.326Z (6 months ago)
• Topics: discord, hacktoberfest, svg, widgets
• Language: JavaScript
• Homepage: http://invidget.switchblade.xyz/
• Size: 594 KB
• Stars: 111
• Watchers: 3
• Forks: 20
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-profile - invidget

README

        


  

  


  


  

  [![ci][ci-badge]][ci-url]

  [![backers][backers-badge]][backers-url]

  [![sponsors][sponsors-badge]][sponsors-url]

  [![docker][docker-badge]][docker-url]





**invidget** generates SVG renders of Discord invites that can be used in GitHub READMEs or even websites. These are a great way to increase conversions and get more people to join your server.

### Base URL:

```

http://invidget.switchblade.xyz/YOUR_INVITE_CODE_OR_SERVER_ID

```

#### Notes

- **When using an invite code**, make sure that your invite is set to never expire, otherwise your widget will break after some time.

- **When using a server ID**, make sure to enable the Server Widget by going to Server Settings ⇒ Widget, checking Enable Server Widget and selecting an Invite Channel.

## Preview

### Dark theme (default)

![Dark theme preview](http://invidget.switchblade.xyz/2FB8wDG)

### Light theme `?theme=light`

![Light theme preview](http://invidget.switchblade.xyz/2FB8wDG?theme=light)

### Different language `?language=pt`

![Light theme preview](http://invidget.switchblade.xyz/2FB8wDG?language=pt)

**⚠ THIS PROJECT IS A WIP!**

## 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](https://en.wikipedia.org/wiki/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](https://jsonlint.com/)

## Sponsors























## Backers























[ci-badge]: https://github.com/SwitchbladeBot/invidget/workflows/CI/badge.svg

[ci-url]: https://github.com/SwitchbladeBot/invidget/actions?query=workflow%3ACI

[backers-url]: https://opencollective.com/switchblade#backer

[backers-badge]: https://opencollective.com/switchblade/tiers/backer/badge.svg?label=backers&color=brightgreen

[sponsors-url]: https://opencollective.com/switchblade#sponsor

[sponsors-badge]: https://opencollective.com/switchblade/tiers/sponsor/badge.svg?label=sponsors&color=brightgreen

[docker-url]: https://hub.docker.com/r/switchbladebot/invidget

[docker-badge]:https://img.shields.io/docker/pulls/switchbladebot/invidget