Kickstart Express

Getting Started

Learn how to install and use Kickstart Express to scaffold your first Express.js project.

Installation

Global Installation

Install Kickstart Express globally to use it from anywhere on your system:

npm install -g kickstart-express

Using npx No Installation Required Recommended

You can also use npx to run Kickstart Express without installing it globally:

npx kickstart-express@latest

Requirements

  • Node.js>= 18.0.0
  • pnpm(recommended) or npm
  • Git(for project initialization)

Your First Project

Once you have Kickstart Express installed, creating your first project is simple:

Interactive Mode

Simply run the command and follow the interactive prompts:

kickstart-express

The CLI will guide you through:

  • Project name - Name for your new project directory
  • Language - Choose between TypeScript or JavaScript
  • Include Dockerfile - Optional Docker configuration
  • Source folder structure - Simple or organized structure
  • Structured architecture - Controllers, services, and routes separation

Non-Interactive Mode

For faster scaffolding, you can pass arguments directly:

kickstart-express --name my-awesome-api --language ts --docker --src --structured

Running Your Project

After creating your project, navigate to the directory and start development:

# Navigate to your project
cd my-awesome-api

# Install dependencies (if not already done)
pnpm install

# Start development server
pnpm dev

Your Express server will be running at http://localhost:3000!

Available Scripts

All generated projects come with these npm scripts:

TypeScript Projects

pnpm dev      # Start development server with hot reload
pnpm build    # Build for production
pnpm start    # Start production server

JavaScript Projects

pnpm dev      # Start development server with nodemon
pnpm start    # Start production server

Docker Projects

docker-compose up --build # Build and run with Docker

Next Steps

Now that you have your first Express.js project running, explore these topics: