Quick Start
Installationâ
Welcome, new Waspeteer đ!
To install Wasp on Linux / OSX / WSL(Win), open your terminal and run:
curl -sSL https://get.wasp-lang.dev/installer.sh | sh
âšī¸ Wasp requires node and will warn you if it is missing: check below for more details.
Then, create a new app by running:
wasp new # Enter the project and choose the template
cd <my-project-name>
wasp 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.
Anything went wrong, or you have additional questions? Check More Details section below!
What next?â
- đ Check out the Todo App tutorial , which will take you through all the core features of Wasp! đ
- If you are using VSCode, install our Wasp language extension.
- 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-lang.dev/#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 (and npm) installed on your machine and available in PATH. We rely on the latest Node.js LTS version (currently v18.14.2).
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 18
Finally, whenever you need to ensure a specific version of node is used, run e.g.
nvm use 18
to set the node version for the 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 .
Installationâ
- Linux / OS X
- Windows
- From source
Open your terminal and run:
curl -sSL https://get.wasp-lang.dev/installer.sh | sh
With Wasp for Windows, we are almost there: Wasp is successfully compiling and running on Windows but there is a bug or two stopping it from fully working. Check it out here if you are interested in helping.
In the meantime, the best way to start using Wasp on Windows is by using WSL. Once you set up Ubuntu on WSL, just follow Linux instructions for installing Wasp. If you need further help, reach out to us on Discord - we have some community members using WSL that might be able to help you.
If you are using WSL2, make sure that your Wasp project is not on Windows file system, but instead on Linux file system. Otherwise, Wasp won't be able to detect file changes, due to the issue in WSL2.
If the installer is not working for you or your OS is not supported, you can try building Wasp from source.
To install from source, you need to clone the wasp repo, install cabal on your machine and then run cabal install from the waspc/ dir.
If you have never built Wasp before, this might take some time due to cabal downloading dependencies for the first time.
Check waspc/ for more details on building.
Give Wasp a spin in the browser without any setup by running our Wasp Template for Gitpod