Installation

Create your project directory

Use the create-charcole CLI to create a new Nodejs project:

npx create-charcole@latest my-project

You can choose between two templates:

• Typescript: Nodejs setup configured perfectly with typescript
• Javascript: Nodejs setup with Javascript

or

npx create-charcole@latest

You’ll be guided through an interactive setup where you can choose:

• Project Name
• Language (Javascript or Typescript)

We recommend using the npm package manager.

After answering the prompts, Charcole will:

• Create your project directory
• Install all required dependencies
• Set up a ready-to-run development environment

Start your Charcole server in development

Move to your docs directory and start your docs server in development mode:

cd my-project
npm run dev

Your app will be available at http://localhost:3000

System Requirements

Before using Charcole, make sure you have:

• Node.js ≥ 18
• npm, pnpm, or yarn

You can verify Node.js with:

node -v

Next Steps

• Explore the generated project structure
• Customize configuration files as needed
• Start building your application

For templates, configuration details, and advanced usage, continue reading the Project Structure.