create-discordjs-project/README.md

A CLI that creates a simple discordjs project

![[Install Size] https://packagephobia.com/result?p=create-discordjs-project](https://packagephobia.com/badge?p=create-discordjs-project)

![[NPM Version] https://www.npmjs.com/package/create-discordjs-project](https://img.shields.io/npm/v/create-discordjs-project.svg?style=flat)

# create-discordjs-project

This is a CLI tool that assists in the creation of discord.js projects.

## Getting Started

```shell
npx create-discordjs-project my-bot
cd my-bot
npm start
```

These commands will create a new folder with the name you inputted in the first argument, e.g: my-bot.

## Usage

With NPX

```shell
npx create-discordjs-project my-bot
```

Install globally with NPM

```sh
npm i -g create-discordjs-project
create-discordjs-project my-bot
```

**_Yarn isn't supported yet._**

_If you want to help you can submit a pull request on our [GitHub](https://github.com/Nemesisly/create-discordjs-project)_

### Flags

- **Skip prompts:** `-y` _or_ `--yes`
- **Initialize a git repo:** `-g` _or_ `--git`
- **Automatically install packages:** `-i` _or_ `--install`
- **Activate verbose:**`-v` _or_ `--verbose`

## How to run the bot?

You can run the bot by entering the directory using:

```shell
cd <directory>
```

and running:

```shell
npm run start
```

## Contributing

Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Acknowledgements

- Thanks Limeline for helping debug and fix my code.