Skip to main content

Getting Started

1. Requirements#

You need to have node (and npm) installed on your machine and available in PATH.

  • node: 16.x.x
  • npm: 8.x.x

You can check node and npm versions by running:

node -vnpm -v

We recommend using nvm for managing your Node.js installation version(s).

Quick guide on installing/using nvm

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

Then, install a version of node that you need, e.g.:

nvm install 16

Finally, whenever you need to ensure specific version of node is used, run e.g.

nvm use 16

to set the node version for current shell session.

You can run

node -v

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

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

info

Why does Wasp require this specific node range and doesn't support a newer version x.y.z?

At Wasp, we focus on supporting the latest LTS ("long-term-support") Node.js version, since it guarantees stability and active maintainance, which is why the official Node.js team recommends it for usage in production. Therefore, a specific Wasp release will usually require the version of Node.js that was LTS at that point of time. Check out https://nodejs.org/en/about/releases/ for more details about Node.js releases.

Sometimes we will make an exception to that and additionally limit the Node.js version or postpone switching to the latest LTS if there are certain issues with new Node.js version, in which case we will catch up once those are resolved on Node.js side or we find a workaround on Wasp side.

2. Installation#

Open your terminal and run:

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

3. Creating and running your first app#

wasp new MyNewApp # Creates a new web app named MyNewApp.cd MyNewAppwasp start # Serves the web app.

That's it ๐ŸŽ‰! You have successfully created and served a new web app at http://localhost:3000 and Wasp is serving both frontend and backend for you.

4. What next?#

Check out the ๐Ÿค“ Todo App tutorial ๐Ÿค“ , which will take you through all the core features of Wasp!

You can also:

  • Join the community on Discord! Any feedback or questions you have, we are there for you.
  • If you are using Visual Studio Code, install our Wasp language extension!