# givies-framework

> A framework to facilitate the development of Discord bots using Eris

Latest version **2022.706.0** (published 2022-07-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install givies-framework
pnpm add givies-framework
yarn add givies-framework
bun add givies-framework
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2022.706.0 |
| Published | 2022-07-06 |
| First published | 2022-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.6.0 |
| Dependencies | 7 |
| Unpacked size | 116.2 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Reinhardt |
| Maintainers | reinhello |
| Keywords | givies, framework, typescript, eris |

## Links

- npm: https://www.npmjs.com/package/givies-framework
- Repository: https://github.com/reinhello/givies-framework
- Homepage: https://github.com/reinhello/givies-framework#readme
- Issues: https://github.com/reinhello/givies-framework/issues
- npm.io page: https://npm.io/package/givies-framework

## Dependencies (7)

- [eris](https://npm.io/package/eris.md) ^0.17.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [tslib](https://npm.io/package/tslib.md) ^2.3.1
- [moment](https://npm.io/package/moment.md) ^2.29.1
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [@types/node](https://npm.io/package/@types/node.md) ^17.0.0
- [serialize-javascript](https://npm.io/package/serialize-javascript.md) ^6.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 2022.706.0 (latest) — 2022-07-06
- 2022.704.1 — 2022-07-04
- 2022.704.0 — 2022-07-04
- 2022.606.1 — 2022-06-06
- 2022.606.0 — 2022-06-06
- 2022.604.0 — 2022-06-04
- 2022.418.1 — 2022-04-18
- 2022.418.0 — 2022-04-18
- 2022.414.1 — 2022-04-14
- 2022.414.0 — 2022-04-14
- 2022.411.0 — 2022-04-11
- 2022.408.0 — 2022-04-08
- 2022.407.2 — 2022-04-07
- 2022.407.1 — 2022-04-07
- 2022.407.0 — 2022-04-07
- … 3 more at https://npm.io/package/givies-framework/versions

## README

# Givies-Framework

[![Discord Server](https://discord.com/api/guilds/772680478888034324/widget.png?style=shield)](https://discord.gg/22v8peAJp8)
[![CI](https://github.com/reinhello/givies-framework/actions/workflows/ci.yml/badge.svg)](https://github.com/reinhello/givies-framework/actions/workflows/ci.yml)
[![CodeFactor](https://www.codefactor.io/repository/github/reinhello/givies-framework/badge)](https://www.codefactor.io/repository/github/reinhello/givies-framework)
[![NPM](https://img.shields.io/npm/v/givies-framework?color=green)](https://npmjs.com/package/givies-framework)
[![Release](https://img.shields.io/github/v/release/reinhello/givies-framework)](https://github.com/reinhello/givies-framework/releases/latest)

A framework to facilitate the development of Discord bots using [Eris](https://github.com/abalabahaha/eris).
## Design Features

This framework includes amazing features such as:

- Giveaways
- Utility Classes
    - Logger
    - RichEmbed Constructor
    - and more...

## Developing a Discord bot using Givies-Framework

- **Requirement:** You will need **[NodeJS v16.6.0+](https://nodejs.org)** installed.

To start developing a Discord bot, you may first initialize a new NodeJS project and install the necessary dependencies. Here's a simple steps how to get done:

- Initialize a NodeJS project: `npm init -y`
- Install Givies-Framework and Eris: `npm install eris givies-framework`
- Open your project using any suitable code editor

**Code Example:**

Below is a very basic example how it works in JavaScript.

```js
const Eris = require("eris");
const GiviesFramework = require("givies-framework");

const client = new Eris.Client("Bot <BOT_TOKEN>", {
    intents: [
        "guilds",
        "guildMessages"
    ]
});
const logger = new GiviesFramework.Utils.Logger();

client.on("ready", () => {
    logger.info({ message: `${client.user.username} is Ready`, subTitle: "Discord::Ready", title: "ERIS" });
});

client.on("messageCreate", async (message) => {
    if (message.author.bot) return;

    if (message.content === "!ping") {
        const embed = new GiviesFramework.Utils.RichEmbed();
            .setTitle("Bot's ping")
            .setDescription(`Pong! | ${message.member.guild.shard.latency}ms`)
            .setColor(0x7289DA);

        return client.createMessage(message.channel.id, { embed: embed });
    }
});

client.connect();
```

## Contributing

Any contributions can be made via [pull requests](https://github.com/reinhello/givies-framework/pulls).

If you are confused where to get started, the [issue-tracker](https://github.com/reinhello/givies-framework/issues) is the best place to track any current existing issues.

**Note:** Please make sure to follow its [Contributing Guidelines](https://github.com/reinhello/givies-framework/blob/master/.github/CONTRIBUTING.md) before proceeding.

## License

This framework is released under the [MIT License](https://github.com/reinhello/givies-framework/blob/master/LICENSE).

---
_Source: https://npm.io/package/givies-framework · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._