Create Ex

Interactive CLI tool to bootstrap a modular typesafe Express API application.

Table of Contents

• Overview
• Getting Started
  • Interactive Mode
  • Non-interactive Mode
  • Cli Options
• Community
• Contributing
• License

Overview

create-ex is designed to kickstart your Express projects with best practices built in. It consists of:

• TypeScript: Built entirely with TypeScript
• Modular API Structure: Routes, controllers, services, and mappers
• Optional Database Integration: Optional Prisma or Drizzle support with multiple database providers:
  • SQLite
  • MySQL
  • Planetscale
  • PostgreSQL
  • MongoDB
• Optional Web Socket Integration: Real-time communication using Socket.IO with modular event handling
• Automated Setup: Initialize Git, install dependencies, and configure project settings effortlessly

It's a CLI tool to streamline the setup of a modular Express API application. Every component is optional, and the final template is generated based on your specific needs. We provide our recommendations for best practices, but ultimately, the decisions are yours.

Getting Started

Interactive Mode

The easiest way to get started is by using the interactive CLI. Run one of the commands below and follow the prompts to configure your new Express project:

# npm
npx create-ex@latest

# yarn
yarn create ex

# pnpm
pnpm create ex@latest

# bun
bun create ex@latest

Non-interactive Mode

If you prefer to create a new project without interactive prompts, you can pass command-line options. For example, run:

npx create-ex my-app --noGit --noInstall -y

Cli Options

When you run npx create-ex --help, you'll see a summary of available options:

Usage: create-ex [options] [dir]

Arguments:
  dir            The name of the application, as well as the name of the directory to create

Options:
  --noGit        Explicitly tell the CLI to not initialize a new Git repo in the project
  --noInstall    Explicitly tell the CLI to not run the package manager install command
  -y, --default  Bypass the CLI and use all default options to bootstrap a new ex-app
  -v, --version  Display the version number
  -h, --help     display help for command

Community

We believe in building a supportive ecosystem. If you have questions or need help:

• Open an issue on our repository.

Contributing

We welcome contributions to improve Create Express App! Please see our CONTRIBUTING.md for more details on how to get started.

License

This project is licensed under the MIT License. See the LICENSE file for details.