@purinton/skeleton

@purinton/skeleton

A modern Discord app built with Node.js, based on the @purinton/discord foundation.

Table of Contents

• Features
• Getting Started
• Configuration
• Running as a Service (systemd)
• Docker
• Customization
  • Commands
  • Events
  • Locales
• Testing
• Support
• License

Features

• Discord.js-based app with ESM support
• Command and event handler architecture
• Multi-language/localized responses
• Environment variable support via dotenv
• Logging and signal handling via @purinton/common
• Ready for deployment with systemd or Docker
• Jest for testing

Getting Started

• Clone this project:

  git clone https://github.com/purinton/skeleton.git
  cd skeleton
  npm install
  

• Set up your environment:

  • Copy .env.example to .env and fill in your Discord app token and other secrets.
  • Edit package.json (name, description, author, etc.)
  • Update this README.md as needed.

• Start the app locally:

  npm start
  # or
  node skeleton.mjs
  

Configuration

• All configuration is handled via environment variables in the .env file.
• See .env.example for required and optional variables.

Running as a Service (systemd)

• Copy skeleton.service to /usr/lib/systemd/system/skeleton.service.

• Edit the paths and user/group as needed.

• Reload systemd and start the service:

  sudo systemctl daemon-reload
  sudo systemctl enable skeleton
  sudo systemctl start skeleton
  sudo systemctl status skeleton
  

Docker

• Build the Docker image:

  docker build -t skeleton .
  

• Run the container:

  docker run --env-file .env skeleton
  

Customization

Commands

• Add new commands in the commands/ directory.
• Each command has a .json definition (for Discord registration/localization) and a .mjs handler (for logic).

Events

• Add or modify event handlers in the events/ directory.
• Each Discord event (e.g., ready, messageCreate, interactionCreate) has its own handler file.

Locales

• Add or update language files in the locales/ directory.
• Localize command names, descriptions, and app responses.

Testing

• Run tests with:

  npm test
  

• Add your tests in the tests/ folder or alongside your code.

Support

For help, questions, or to chat with the author and community, visit:

Purinton Dev on Discord

License

MIT © 2025 Russell Purinton

Links

• GitHub Repo
• GitHub Org
• GitHub Personal
• Discord