Git Product home page Git Product logo

pfm-js's Introduction

pfm-js

pfm-js logo

License Version Size Last Commit Code Size

A weird Discord bot, lover of cookies and banana bread. He's nice though, we promise. PFM uses the Discord.js library.

Installation

Requirements

Setting up your environment

  1. Fork this repository
  2. Then clone your forked repository to your local machine
  3. Install the dependencies with either bun install or npm install

Creating a Discord application

  1. Go to the Discord Developer Portal
  2. Click on "New Application" and give it a name
  3. Go to the "Bot" tab and click on "Add Bot"
  4. Click on "Copy" under "Token" and paste it into a file called config.json in the root of the repository. Don't share this token with anyone! It will look like this:
{
    "token": "your-token-here"
}
  1. Invite your bot to your server by going back to the General Infomration tab, and writing down the Client ID. Replace CLIENT_ID in the following URL with that number and paste it into your web browser:
    https://discord.com/oauth2/authorize?client_id=CLIENT_ID&scope=bot
  2. Follow the on-screen instructions to invite your bot to your server

Running the bot

Simply use bun start or npm start to start the bot. If this is not working, feel free to use bun boot.ts or node boot.js instead.

Bonus: clam

Clam is the fun little tool used to clean up the log files generated by the bot @ deploy-commands.log and index.log. Easiest way to use it is to run bun clam.ts, in the root of the repository. It will clean up the logs, assuming they're not empty, and then exit.

pfm-js's People

Contributors

strawberrymaster avatar dependabot[bot] 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.