Skip to main content
Version: 0.16.0

Quick Start

Installation​

Welcome, new Waspeteer 🐝!

Let's create and run our first Wasp app in 3 short steps:

  1. To install Wasp on Linux / OSX / WSL (Windows), open your terminal and run:

    curl -sSL https://get.wasp.sh/installer.sh | sh

    ℹī¸ Wasp requires Node.js and will warn you if it is missing: check below for more details.

  2. Then, create a new app by running:

    wasp new

  3. Finally, run the app:

    cd <my-project-name>
    wasp start

That's it 🎉 You have successfully created and served a new full-stack web app at http://localhost:3000 and Wasp is serving both frontend and backend for you.

Something Unclear?

Check More Details section below if anything went wrong with the installation, or if you have additional questions.

Want an even faster start?

Try out Wasp AI 🤖 to generate a new Wasp app in minutes just from a title and short description!

Try Wasp Without Installing 🤔?

Give Wasp a spin in the browser with GitHub Codespaces by following the intructions in our Tutorial App README

What next?​

  • 👉 Check out the Todo App tutorial, which will take you through all the core features of Wasp! 👈
  • Setup your editor for working with Wasp.
  • Join us on Discord! Any feedback or questions you have, we are there for you.
  • Follow Wasp development by subscribing to our newsletter: https://wasp.sh/#signup . We usually send 1 per month, and Matija does his best to unleash his creativity to make them engaging and fun to read :D!

More details​

Requirements​

You must have Node.js (and NPM) installed on your machine and available in PATH. A version of Node.js must be >= 20.

If you need it, we recommend using nvm for managing your Node.js installation version(s).

A quick guide on installing/using nvm

Install nvm via your OS package manager (apt, pacman, homebrew, ...) or via the nvm install script.

Then, install a version of Node.js that you need:

nvm install 20

Finally, whenever you need to ensure a specific version of Node.js is used, run:

nvm use 20

to set the Node.js version for the current shell session.

You can run

node -v

to check the version of Node.js currently being used in this shell session.

Check NVM repo for more details: https://github.com/nvm-sh/nvm.

Installation​

Open your terminal and run:

curl -sSL https://get.wasp.sh/installer.sh | sh
Running Wasp on Mac with Mx chip (arm64)

Experiencing the 'Bad CPU type in executable' issue on a device with arm64 (Apple Silicon)? Given that the wasp binary is built for x86 and not for arm64 (Apple Silicon), you'll need to install Rosetta on your Mac if you are using a Mac with Mx (M1, M2, ...). Rosetta is a translation process that enables users to run applications designed for x86 on arm64 (Apple Silicon). To install Rosetta, run the following command in your terminal

softwareupdate --install-rosetta

Once Rosetta is installed, you should be able to run Wasp without any issues.