https://github.com/ipuppyyt/typescript-djs

https://github.com/ipuppyyt/typescript-djs

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ipuppyyt/typescript-djs
• Owner: ipuppyyt
• Created: 2024-11-03T06:22:03.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-17T11:21:15.000Z (about 2 months ago)
• Last Synced: 2025-01-08T09:48:36.964Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 229 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# TypeScript Discord Bot Template





![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat&logo=typescript&logoColor=white)

![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=flat&logo=vite&logoColor=white)

![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=flat&logo=SASS&logoColor=white)

![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=flat&&logo=tailwind-css&logoColor=white)

![Discord.js](https://img.shields.io/badge/Discord.js-v14.16.3-7289DA?style=flat&logo=discord&logoColor=white)

![Node.js](https://img.shields.io/badge/Node.js-v18.0.0-339933?style=flat&logo=node.js&logoColor=white)

![License](https://img.shields.io/badge/license-ISC-blue.svg?style=flat)

![Issues](https://img.shields.io/github/issues/ipuppyyt/typescript-djs?style=flat)

![Last Commit](https://img.shields.io/github/last-commit/ipuppyyt/typescript-djs?style=flat)

[![Tests](https://github.com/ipuppyyt/typescript-djs/actions/workflows/test.yml/badge.svg)](https://github.com/ipuppyyt/typescript-djs/actions/workflows/test.yml)

A simple and elegant Discord bot template built with TypeScript, designed to help you get started with your own Discord bot quickly and easily.



## Table of Contents

- [Features](#features)

- [Installation](#installation)

- [Usage](#usage)

- [Contributing](#contributing)

- [License](#license)

## Features

- **TypeScript Support:** Strong typing for improved development experience.

- **Modular Structure:** Easy to add and manage features.

- **Environment Variables:** Simple configuration using `.env` files.

- **Database Integration:** Preconfigured with Mongoose for MongoDB support.

- **Cross-Environment Scripts:** Easy development and production scripts.

## Requirements

- **NodeJS 18**

- **Typescript**

## Installation

To get started with this template, clone the repository and install the dependencies.

```bash

git clone https://github.com/ipuppyyt/typescript-djs.git

cd typescript-djs

npm install

```

## Usage

### Development

To start the bot in development mode, run:

```bash

npm run dev

```

### Production

To start the bot in production mode, run:

```

npm start

```

Make sure to create a .env file in the root directory of your project and set your Discord bot token and other configurations as needed.

## Contributing

Contributions are welcome! If you have suggestions for improvements or want to report a bug, please open an issue or submit a pull request.

- Fork the repository.

- Create your feature branch (git checkout -b feature/MyFeature).

- Commit your changes (git commit -m 'Add some feature').

- Push to the branch (git push origin feature/MyFeature).

- Open a Pull Request.

## License

This project is licensed under the ISC License.