Giter VIP home page Giter VIP logo

ptkdev-boilerplate / node-discord-bot-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
14.0 3.0 5.0 2.27 MB

๐Ÿค– Create discord bot with this friendly nodejs boilerplate

Home Page: https://npmjs.com/package/@ptkdev/node-discord-bot-boilerplate

License: Other

JavaScript 8.97% Shell 0.21% Dockerfile 3.41% Smarty 5.44% TypeScript 81.96%
discord discord-bot discord-bot-framework discord-bot-template github-templates discord-bot-boilerplate typescript discordjs discordjs-bot

node-discord-bot-boilerplate's Introduction

๐Ÿค– node-discord-bot-boilerplate

v1.0.20210412 License: MIT Language: TypeScript ECMAScript: 2019 Discord Server

Create your discord bot with this friendly boilerplate. Use this repository as template for your bot

This is a github template, you can fork it or use as template for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this problem.

๐ŸŽ Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

Donate Paypal Donate Ko-Fi Donate Github Sponsors Donate Patreon Donate Bitcoin Donate Ethereum

๐Ÿ“Ž Menu

๐Ÿ’ก Features

  • [โœ”๏ธ] Easy to use
  • [โœ”๏ธ] MIT License
  • [โœ”๏ธ] Make discord bot with node
  • [โœ”๏ธ] Friendly boilerplate + Github templates
  • [โœ”๏ธ] Typescript + TSPaths preconfigured
  • [โœ”๏ธ] Userfriendly folders tree
  • [โœ”๏ธ] Prettiers and ESLint preconfigured
  • [โœ”๏ธ] all-contributors-cli and all-shields-cli preconfigured
  • [โœ”๏ธ] JEST Test preconfigured
  • [โœ”๏ธ] Full async code
  • [โœ”๏ธ] Github and Vscode dotfiles preconfigured
  • [โœ”๏ธ] Translations: ๐Ÿ‡ฌ๐Ÿ‡ง ๐Ÿ‡ฎ๐Ÿ‡น ๐Ÿ‡ต๐Ÿ‡ฑ (Help me โค๏ธ)

๐Ÿš€ Usage: Deploy

  1. Clone this repository or download nightly, beta or stable.
  2. Create new application on discord developer page:
  • A. Click "Bot" on left menu, generate new bot and save token for step 3
  • B. Click "oAuth2" on left menu, go to bottom and set scope as BOT and check all write permissions. Copy generated link and invite bot to your server.
  1. Run with correct values: npm run init:token --token asdfghjkl
  2. Run npm run init
  3. Run npm run start-pm2
  4. Write /start on discord bot.

๐Ÿ”จ Developer Mode

๐Ÿ Run Project

  1. Clone this repository or download nightly, beta or stable.
  2. Create new application on discord developer page:
  • A. Click "Bot" on left menu, generate new bot and save token for step 3
  • B. Click "oAuth2" on left menu, go to bottom and set scope as BOT and check all write permissions. Copy generated link and invite bot to your server.
  1. Run with correct values: npm run init:token --token asdfghjkl
  2. Run npm run init
  3. Run npm run dev
  4. Write /start on discord bot.

๐Ÿ’พ Setup Project

If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit setup.json with correct values and run npm run setup.

๐Ÿš€ Deploy

Deploy bot to your server and:

  1. Run with correct values: npm run init:token --token asdfghjkl
  2. Run init npm run init
  3. Generate release npm run release
  4. Start bot npm run start-pm2

๐Ÿ“š Documentation

Run npm run docs

๐Ÿ‘‘ Backers and Sponsors

Thanks to all our backers! ๐Ÿ™ Donate 3$ or more on paypal, ko-fi, github or patreon and send me email with your avatar and url.

๐Ÿ‘จโ€๐Ÿ’ป Contributing

I โค๏ธ contributions! I will happily accept your pull request! Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together ๐Ÿ‘ฏ and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):


Patryk Rzucidล‚o

๐Ÿ’ป ๐ŸŒ ๐Ÿ“– ๐Ÿ›

Alรฌ Shadman
๐Ÿ’ป ๐ŸŒ ๐Ÿ“– ๐Ÿ›

๐Ÿ’ฐ In the future, if the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

๐Ÿฆ„ Other Projects

๐Ÿ’ซ License

  • Code and Contributions have MIT License
  • Images and logos have CC BY-NC 4.0 License
  • Documentations and Translations have CC BY 4.0 License

node-discord-bot-boilerplate's People

Contributors

ptkdev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.