Devian

A discord bot + API, created with typescript

Report Bug · Request Feature

About The Project

Built With

• Node
• Express
• Typescript
• Discord.js

(back to top)

Getting Started

See prerequisites, how to install and run your own discord bot.

Prerequisites

• Node

  • Go to https://nodejs.org
  • Download it in version 16 or higher

• Yarn

  npm install -g yarn@latest

Installation

1. Get a discord API Key at Discord developers

   • First create a new application
   • Go to "Bot" and create a new Bot
   • Set a name to the Bot
   • Click on "Reset token" and copy the new token

2. Clone the repo

   git clone https://github.com/johncovv/devian

3. Install NPM packages

   yarn install

4. Create an environment file named .env on the root folder, with the content:

   CLIENT_TOKEN=PlaceHereYourApiBotToken

5. Run the project

   yarn run dev

6. Invite the bot to your server

   • Go to your discord application
   • Select "OAuth2" in the side menu
   • Select the "bot" option on scopes
   • Scroll to "BOT PERMISSIONS" and select "Administrator"
   • After that, enter the url generated below

Issues

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request to branch develop

Contact

John Covv - @johncovv - contato@johncovv.com

(back to top)