\nFonzi2 is an incredibly simple and fast Discord bot framework focused on a better dev experience, built using TypeScript and Discord.js. It provides a structured architecture with automatic command registration, event handling, and OAuth2 server-side functionality.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Features](#features)\n- [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n - [Quick Start](#required-steps)\n- [Contributing](#contributing)\n- [Deployment](#deployment)\n - [Serverless](#serverless-replit)\n - [Dedicated Server](#dedicated-server-pm2)\n\n## Introduction\n\nDeveloping a robust and scalable Discord bot can be a daunting task, especially for beginners. Fonzi2 simplifies this process by providing a structured framework that takes care of the essential boilerplate code and common discord bot functionalities.\n\n## Features\n\n- Structured bot architecture with automatic command registration and event handling\n- TypeScript support for type safety and code maintainability\n- Cookie-session management for secure user sessions\n- OAuth2 server-side functionality for user authentication and authorization\n- Lightweight and extensible framework to adapt to various bot requirements\n- Centralized on Discord API\n\n## Getting Started\nThe package has been created and tested with **Node.js Version 18 and 20**.\n \n**pnpm >= 8.14** was used as the package manager\n \nI reccomend using nvm (Node Version Manager).\n\n### Installation\n ```bash\n npm install fonzi2 discord.js \n ```\n\n### Other packages you should install\n- for customizing the SSR\n ```bash\n npm install express ejs cookie-session\n ```\n\n### Required steps\n\n1. Create a new application in the [Discord Developer Portal](https://discord.com/developers/applications).\n\n2. Obtain the bot token from the Bot tab of your newly created application.\n\n3. [Invite link] Generate an OAuth2 URL using the OAuth2 URL Generator in the Discord Developer Portal.\n Select the `bot` scope and the permissions you need to generate the bot invite link.\n\n4. [ServerSide OAuth2] Generate an OAuth2 URL using the OAuth2 URL Generator in the Discord Developer Portal. Select the \"identify\" scope and `http://localhost:/login` as your redirect uri for development and **CHANGE `response_type` to `token`**.\n\n - For production: you will need to create a new OAuth2 url using the hostname of your deployment (ex. https://fonzi2.railway.app/login as the redirect uri), remember to **CHANGE `response_type` to `token`**.\n\n## Contributing\n\nI welcome contributions to the project. Feel free to open issues or submit pull requests with improvements or bug fixes.\n\n\n## Deployment\n\n### Dedicated Server (PM2)\n\nYou can host your bot on a dedicated server using the [pm2 package](https://pm2.keymetrics.io).\n\n1. Set up Node.js and npm on your server.\n2. **Install PM2:**\n\n If you don't have PM2 installed on your server, install it globally:\n\n ```bash\n npm install pm2 -g\n ```\n\n3. Clone your bot repository onto the server:\n\n ```bash\n git clone https://github.com/your-username/your-bot.git\n cd fonzi2\n ```\n\n4. Install dependencies:\n ```bash\n npm install\n ```\n5. **Configure .env**\n ```bash\n TOKEN=your-bot-token\n LOG_WEBHOOK=optional-webhook-url\n INVITE_LINK=bot-invite-link\n # Production OAuth2 url\n OAUTH2_URL=your-oauth2-url\n OWNER_IDS=your-user-id,contributors-user-ids\n ```\n6. Build the project and start the process\n ```bash\n npm run build\n pm2 start npm --name \"fonzi2\" -- start\n ```\n - Replace \"fonzi2\" with your desired PM2 process name.\n7. Monitor and Manage:\n\n ```bash\n # see pm2 logs\n pm2 logs fonzi2\n\n # stop the bot\n pm2 stop fonzi2\n\n # restart the bot\n pm2 restart fonzi2\n\n # view process information\n pm2 show fonzi2\n ```\n\n### Serverless ([Railway](https://railway.app))\n\nBy far the simplest way to host a Discord bot for **free***, this approach is excellent for small to medium-sized applications with minimal resource requirements, but theres also premium options for more demanding apps.\n\n1. Sign in to [Railway](https://railway.app) with GitHub.\n - Click on \"Create project\" to create a new project.\n - Select \"Deploy from GitHub repo\" and select your bot repository.\n2. **Setup env**\n - **DO NOT** push the `.env` file to your repo as it contains sensible information about your bot that would become public, instead create **Service Variables** on railway, you can just copy and paste your existing `.env`, but make sure to change the necesarry variables to their production counterparts.\n\n3. There is no step 3, you are done!\n - Whenever you push to the default branch in your repo railway will fetch the changes and redeploy the bot, it goes without saying that the bot will stay online 24/7 without any external needs\n","readmeFilename":"README.md"}
![\"Discord](\"https://img.shields.io/discord/1122938014637756486?color=5865F2&logo=discord&logoColor=white\")
\n \n\t\t\n ![\"package](\"https://img.shields.io/npm/v/fonzi2.svg?maxAge=3600\")
\n \n\t\t\n ![\"npm](\"https://img.shields.io/npm/dt/fonzi2.svg?maxAge=3600\")
\n \n \n ![\"Tests](\"https://github.com/LJS360d/fonzi2/actions/workflows/build.yml/badge.svg\"){kind=icon}
\n \n\t