Giter VIP home page Giter VIP logo

majobot's Introduction

This project is outdated! It will soon be upgraded to Discord.js v12.3.1. If you want to see the progress of the work see @aurolia-css/majo-rebuild (official repo)

Majo.exe

An advanced Discord bot, contains commands for moderation, fun, music, economics and NSFW.

Discord

Jekyll Node.js Workflow GitHub License Version

Invite

Go to this link and authorize the bot (requires server manage premission) to your server.

Hosting

We host this bot. Majo.exe will be online 24/7.

Deploy

Deploy the app to Heroku

Deploy to heroku

Self-Hosting

  1. Clone this repository,
  2. Run npm install,
  3. Grab a token and client secret on Discord's developer portal,
  4. Fill config.json and dashboard.json with your variables (dashboard.json is the config file for Web Dashboard, ignore this file if you not use Majo Dashboard),
  5. Create a .env file and add a TOKEN environmental variable whose value is the token above. (Do not remember! The TOKEN value is Super-Secret)
  6. In .env Set PREFIX - this is your bot prefix, a SECRET - this is your client secret variabble (Used for web-dashboard), a Google Trakcing ID (For Website analytics) - UA=TRACKING-ID if you don't have to use analytics just delete the settings value and add a DASHBOARD=[true/false] value - if true the bot will be hosted with web dasboard, if false the bot will be hosted without web dashboard (The .env file was private).
  7. Run node index.js

NOTE: See the example .env file below!

Example .env file

# Environment Config

# store your secrets and config variables in here
# only invited collaborators will be able to see your .env values

# reference these in your code with process.env.SECRET


TOKEN=YOUR-TOKEN-GOES-HERE
PREFIX=!majo
DASHBOARD=true
SECRET=YOUR-BOT-CLIENT-SECRET
UA=YOUR-GOOGLE-TRACKING-ID

# !majo is the default prefix, you can change it later.

# note: .env is a shell file so there can't be spaces around =

.env Description Required
TOKEN The bot token, required to run (Do not remember! The TOKEN value is Super-Secret) ✔️
PREFIX The default bot prefix (eg. !majo) ✔️
DASHBOARD The Web-Dashboard config value. (eg. true/false)
SECRET The bot client secret (Do not remember! The SECRET value is Super-Secret), required to run Web Dashboard
UA Google analytics tracking ID, used in Web-Dashboard

Development

Node.js Version

To test site in .env file set the DASHBOARD=true/false value. (See example .env file)

Jekyll Version

To set up your environment to develop this page, run bundle install.

To test site, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your config and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.

Issues

If you have any issues with the page please create new issue here

Pull Requests

When submitting a pull request:

  • Clone the repo.
  • Create a branch off of master and give it a meaningful name (e.g. my-awesome-new-feature).
  • Open a pull request on GitHub and describe the feature or fix.

License

This project is licensed under the MIT. See the LICENSE file for details

majobot's People

Contributors

igorkowalczyk avatar

Watchers

 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.