Create-sunar NPM

Create Sunar

create-sunar is a CLI tool to quickly set up a new Discord bot project using the Sunar framework with discord.js.

Getting Started

To create a new Sunar bot project, run the following command:

npm create sunar@latest
# or
yarn create sunar@latest
# or
pnpm create sunar@latest
# or
bun create sunar@latest

You will be prompted to enter some details about your project, such as the project name, preferred language (TypeScript or JavaScript), and desired features (e.g., Biome, TSX, TSUP, Prettier, ESLint).

Features

create-sunar allows you to customize your bot project with various features:

Biome: Format, lint, and more in a fraction of a second.
TSUP: A fast and minimalist TypeScript bundler.
TSX: Easiest way to run TypeScript in Node.js.
Nodemon: Monitor for any changes in your Node.js code.
Prettier: Format your project code.
ESLint: Lint your project code.

Scripts

You can use the following scripts to manage your project:

start: Launch the bot in production mode.
dev: Run the bot in development mode.
build: Build the project (if using TypeScript).
lint: Lint the project (if Biome or ESLint is selected).
format: Format the project (if Biome or Prettier is selected).

Learn More

To learn more about Sunar, check out the following resources:

Sunar Documentation - Learn about Sunar features and API.
Getting Started with Sunar - An interactive Sunar tutorial.
Sunar GitHub Repository - Your feedback and contributions are welcome!

Credits

Special thanks to discord.js for their incredible library that powers Sunar, to Valibot for inspiring our code structure, and to Fumadocs for being an excellent framework for creating documentations.