Installation

Installation

Learn how to install and configure wexts on your development machine.

System Requirements

  • Node.js 18.17 or later
  • pnpm 8.0 or later (recommended)
  • macOS, Windows, or Linux

Automatic Installation

The easiest way to create a new wexts project is using create-wexts-app:

terminalbash
npx create-wexts-app@latest my-app

This command will:

  • Create a new directory with your project name
  • Set up the monorepo structure with TurboRepo
  • Install all necessary dependencies
  • Configure TypeScript, ESLint, and Prettier
  • Set up Next.js frontend and NestJS backend

Manual Installation

If you prefer to set up your project manually, follow these steps:

1. Install pnpm

bash
npm install -g pnpm

2. Clone Template

bash
git clone https://github.com/wexts/template my-app
cd my-app

3. Install Dependencies

bash
pnpm install

4. Set Up Environment

bash
cp .env.example .env

Environment Variables

Make sure to configure your .env file with your database connection string and other required variables.

Verify Installation

Start the development servers to verify everything is working:

bash
pnpm dev

You should see output indicating both servers are running:

  • Frontend: http://localhost:3000
  • Backend: http://localhost:5050

Installation Complete!

Your wexts development environment is ready. Continue to the Quick Start guide to build your first application.