https://github.com/kibotrel/idlemmo-bot

Discord bot to enhance the IdleMMO experience.
https://github.com/kibotrel/idlemmo-bot

discordbot discordjs idlemmo typescript

Last synced: 13 days ago
JSON representation

Discord bot to enhance the IdleMMO experience.

• Host: GitHub
• URL: https://github.com/kibotrel/idlemmo-bot
• Owner: kibotrel
• License: unlicense
• Created: 2023-12-14T21:15:28.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2024-02-13T11:46:04.000Z (12 months ago)
• Last Synced: 2024-10-28T17:35:15.861Z (4 months ago)
• Topics: discordbot, discordjs, idlemmo, typescript
• Language: TypeScript
• Homepage:
• Size: 471 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Typescript Project Template

This includes a basic setup for a typescript project with all the scripts needed to develop, build, test and publish any package written in Typescript.

## :package: What's in the box ?

Aside of the obvious Typescript support, this template includes the following features:

- A strict Typescript configuration.

- A targeted node version (specified in `.nvmrc`).

- A Dependabot policy to keep dependencies up to date.

- [eslint](https://eslint.org/) with a strong configuration (mostly formatting and quality of life rules).

- [prettier](https://prettier.io/) to enforce a consistent code style.

- [vitest](https://vitest.dev/) to run tests.

- [nodemon](https://nodemon.io/) to speed up development.

- [commitlint](https://commitlint.js.org/) to enforce a consistent commit message style.

- [husky](https://typicode.github.io/husky/#/) to run scripts on git hooks.

## :rocket: Getting started

Once cloned, you can run the following commands:

- `pnpm install` installs all the dependencies, setup husky and commitlint git hooks.

- `nvm use` sets the node version to the one specified in `.nvmrc` (if you use [nvm](https://github.com/nvm-sh/nvm))

- `pnpm dev` starts a `nodemon` process and gets you ready to develop.

> :information_source: [pnpm](https://pnpm.io/) is taken as an example here. You can use any package manager thanks to [pm-exec](https://github.com/slune-org/pm-exec).