Home
Softono
shortem

shortem

Open source JavaScript
19
Stars
9
Forks
0
Issues
3
Watchers
4 years
Last Commit

About shortem

# Shortem A URL Shortener That Allow Users To Interact With Its API Through A Discord Bot ## About - Supports Multiple [Databases](./example/database.js) - Performant - Uses [discord.js](https://github.com/discordjs/discord.js) v13 - Uses Slash Commands - Validates URL - Customizable, Using Command Handling Method ## Commands/API - `/create <slug> <url>` - Create A Slug - `/delete <slug>` - Delete A Slug - `/list` - A List Of Available Slugs - `/info <slug/url>` - View Slug's Information - `deploy` - Deploy Slash Commands ( Owner ) ## Requirements - Node.js 16.2.0^ ( see why : [here](https://github.com/BotStudios/shortem/wiki/node.js-16.2.0%5E-is-required,-why-%3F) ) - Install All Required Dependencies ## Setup 1. Clone This Repository ( By `git clone` Or [`create-shortem-app`](https://npmjs.com/create-shortem-app) ) 2. Edit The [Config File](./config.json) 3. Run The Bot `npm start` / `node src/index.js` ## Credits **Code** - Inspired by [CodingGarden/miniature-umbrella](https://github.com/CodingGard ...

Platforms

Web Self-hosted iOS

Languages

JavaScript

Links

Shortem

A URL Shortener That Allow Users To Interact With Its API Through A Discord Bot

About

  • Supports Multiple Databases
  • Performant
  • Uses discord.js v13
  • Uses Slash Commands
  • Validates URL
  • Customizable, Using Command Handling Method

Commands/API

  • /create <slug> <url> - Create A Slug
  • /delete <slug> - Delete A Slug
  • /list - A List Of Available Slugs
  • /info <slug/url> - View Slug's Information
  • deploy - Deploy Slash Commands ( Owner )

Requirements

  • Node.js 16.2.0^ ( see why : here )
  • Install All Required Dependencies

Setup

  1. Clone This Repository ( By git clone Or create-shortem-app )
  2. Edit The Config File
  3. Run The Bot npm start / node src/index.js

Credits

Code

Dependencies

discord.js, @discordjs/rest, discord-api-types, dotenv, express, helmet, joi

Contributors

@joeleeofficial, @leecheeyong

License

This project is available as open source under the terms of the GPL-3.0 License