https://github.com/almeidx/cozyhive-bot

https://github.com/almeidx/cozyhive-bot

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/almeidx/cozyhive-bot
• Owner: almeidx
• License: gpl-3.0
• Created: 2023-02-24T16:47:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T19:19:27.000Z (4 months ago)
• Last Synced: 2024-09-11T18:21:59.399Z (4 months ago)
• Language: TypeScript
• Homepage: https://discord.gg/cozyhive
• Size: 2.33 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Table of Contents

- [Table of Contents](#table-of-contents)

  - [Overview](#overview)

    - [Local setup](#local-setup)

      - [Cloning repository](#cloning-repository)

      - [Running the bot locally](#running-the-bot-locally)

    - [Author](#author)

---

## Overview

This repository houses the source code for the [Cozyhive] Discord bot, which has the responsibility of syncing boosts

across the multiple Discord servers, amongst other things.

---

### Local setup

This setup assumes you have [Git], and [Node.js] setup on your machine. This repository requires [Node.js] version 22 or

higher, and uses the [pnpm] package manager, so you should have basic knowledge about how to use them.

#### Cloning repository

- `git clone [email protected]:almeidx/cozyhive-bot.git`

- `cd cozyhive-bot`

- `corepack install`

- `pnpm i`

Note: If you don't have corepack enabled, you can do it with `corepack enable`.

#### Running the bot locally

Copy the `.env.example` file to `.env` and fill in the required values. Make sure to keep the `NODE_OPTIONS` value as it

is.

- `pm2 start ecosystem.config.cjs`

---

### Author

**cozyhive-bot** © [almeidx], released under the [GNU AGPLv3] license.

> GitHub [@almeidx]

[cozyhive]: https://discord.gg/cozyhive

[git]: https://git-scm.com/

[node.js]: https://nodejs.org

[pnpm]: https://pnpm.io/

[gnu agplv3]: https://github.com/almeidx/cozyhive-bot/blob/main/LICENSE

[almeidx]: https://almeidx.dev

[@almeidx]: https://github.com/almeidx