Repository: wasp-lang/wasp

Stars: 18248

CLAUDE.md Copy Chapter

Wasp Monorepo

Wasp is a full-stack web framework that compiles .wasp configuration files into React + Node.js applications. The compiler is written in Haskell.

Repository Structure Copy Chapter

- waspc/ — Haskell compiler, CLI, and LSP server (the core of Wasp)
- src/ — Main compiler library (Analyzer, Generator, AppSpec, Psl)
- cli/src/ — CLI commands (start, build, new, deploy, etc.)
- waspls/ — Language Server Protocol implementation
- data/packages/ — TypeScript packages called by the CLI when compiling projects as FFI
- data/Generator/libs/ — TypeScript libraries embedded into generated project code
- data/Generator/templates/ — Mustache templates for code generation
- e2e-tests/ — Golden file snapshot tests
- run — Main development script (run ./run with no args to see all commands)
- wasp-app-runner/ — Node.js CLI for running Wasp apps in e2e tests
- web/ — Documentation website (Docusaurus), deployed to wasp.sh
- mage/ — Web frontend for wasp new:ai, which generates Wasp apps from a description
- examples/ — Tutorial and example apps (kitchen-sink, waspello, etc.)
- scripts/ — Monorepo-level build/packaging scripts

Build & Development Copy Chapter

All waspc development commands run from the waspc/ directory via the ./run script. Run ./run with no arguments to see the full list of available commands (build, test, format, lint, etc.).

Key things to know:

- Two-phase build: TS packages in data/packages/ and libs in data/Generator/libs/ compile first, then Haskell (which embeds them). Use ./run build for the full build.
- Run the dev CLI with ./run wasp-cli <args>.
- Toolchain versions (GHC, HLS) are specified in waspc/cabal.project and waspc/dev-tool.project. Use ./run ghcup-set to set the correct versions.
- Node.js minimum version is in .nvmrc.

Code Conventions Copy Chapter

Haskell Copy Section

- Simple, readable Haskell — no complicated features. See CONTRIBUTING.md.
- Default extensions are listed in waspc/waspc.cabal.
- CamelCase for types/modules, camelCase for functions/values.
- Qualified imports preferred.
- Formatting: Ormolu (./run check:ormolu / ./run format:ormolu). Linting: HLint (./run hlint, config in waspc/.hlint.yaml).
- Tests use tasty + hspec + QuickCheck, mirroring source module paths with a Test suffix.

TypeScript/JavaScript Copy Section

- Prettier-formatted (config in .prettierrc). Check/fix with ./run check:prettier / ./run format:prettier.
- camelCase for files/functions, PascalCase for components/types.

Architecture Copy Section

- Analyzer parses .wasp files → AppSpec (IR) → Generator produces React/Node.js code.
- Code generation uses a file draft system and Mustache templates in data/Generator/templates/.

Important Rules Copy Chapter

- E2E snapshots (waspc/e2e-tests/test-outputs/snapshots/) must never be manually edited. Regenerate them by running cd waspc && ./run build && ./run test:waspc:e2e:accept-all.
- Documentation: Only edit web/docs/ (the latest version). Do not modify web/versioned_docs/ — those are auto-generated snapshots of previous versions.
- Pull requests: Always use the repo's PULL_REQUEST_TEMPLATE.md. Never delete any checkbox from the template — leave irrelevant ones unchecked.

README.md Copy Chapter

<div>
<!-- INTRO -->
<div align=center>
<img height="80px" src="https://user-images.githubusercontent.com/1536647/77317442-78625700-6d0b-11ea-9822-0fb21e557e87.png"/>
<p>The fastest way to develop full-stack web apps with React & Node.js.</p>
</div>
<br />
<!-- BADGES -->
<div align=center>
<a href="https://github.com/wasp-lang/wasp/blob/main/LICENSE"><img alt="license" src="https://img.shields.io/github/license/wasp-lang/wasp"></a>
<a href="https://github.com/wasp-lang/wasp/releases/latest"><img alt="latest release" src="https://img.shields.io/github/v/release/wasp-lang/wasp"/></a>
<a href="https://discord.gg/rzdnErX"><img alt="discord" src="https://img.shields.io/discord/686873244791210014?label=chat%20@%20discord"/></a>
</div>
<br />
<!-- LINKS -->
<div align=center>
<a href="https://wasp.sh">Website</a>
|
<a href="https://wasp.sh/docs">Docs</a>
</div>
<div align=center>
<a href="https://discord.gg/rzdnErX">Discord</a>
|
<a href="https://x.com/WaspLang">Twitter</a>
|
<a href="https://www.youtube.com/@wasplang">Youtube</a>
</div>
<div align=center>
<a href="https://e44cy1h4s0q.typeform.com/to/EPJCwsMi">Deployed? Get swag! 👕</a>
</div>
</div>

---

What is Wasp? Copy Chapter

Wasp (Web Application Specification) is a Rails-like framework for React, Node.js, and Prisma.
Build your app in a day and deploy it with a single CLI command!

Why is Wasp awesome Copy Section

- 🚀 Quick start: Due to its expressiveness, you can create and deploy a production-ready web app from scratch with very few lines of concise, consistent, declarative code.
- 😌 No boilerplate: By abstracting away complex full-stack features, there is less boilerplate code. That means less code to maintain and understand! It also means easier upgrades.
- 🔓 No lock-in: You can deploy the Wasp app anywhere you like. There is no lock-in into specific providers; you have complete control over the code (and can actually check it out in .wasp/ directory if you are interested ).
- 🤖 Perfect for AI by design: Thanks to its high-level spec of the whole app, opinionated approach, built-in full-stack features, and tight integration of all parts of the stack, Wasp gives AI (agents) clear guardrails and structure, less boilerplate to manage, and better context management.

Features Copy Section

- 🔒 Full-stack Auth
- 🖇️ RPC (Client <-> Server)
- 🚀 Simple Deployment
- ⚙ ️Jobs
- ✉️ Email Sending
- 🛟 Full-stack Type Safety
- ...

Code example Copy Section

Simple Wasp config file in which you describe the high-level details of your web app:

// file: main.wasp
app TodoApp {
  title: "TODO App",  // visible in the browser tab
  wasp: { version: "^0.18.1" },
  auth: { // full-stack auth out-of-the-box
    userEntity: User,
    methods: { email: {...}, google: {...}, }
  }
}
route RootRoute { path: "/", to: MainPage }
page MainPage {
  authRequired: true, // Limit access to logged-in users.
  component: import MainPage from "@src/MainPage" // Your React code.
}
query getTasks {
  fn: import { getTasks } from "@src/queries", // Your Node.js code.
  entities: [Task] // Automatic cache invalidation.
}

And a Prisma schema for the database:

// file: schema.prisma
model Task { // Your Prisma data model.
  id          Int     @id @default(autoincrement())
  description String
  isDone      Boolean @default(false)
}

The rest of the code you write in React / Node.js and reference it from the .wasp file.

👉 Check out TodoApp example for a complete code example. 👈

How it works Copy Section

<img width="800px" src="https://user-images.githubusercontent.com/1536647/231472285-126679e5-ecce-4cbb-8579-eb3cd9ba95bf.png"/>

Given a simple .wasp configuration file that describes the high-level details of your web app, and .ts(x)/.css/..., source files with your unique logic, Wasp compiler generates the whole source of your web app in the target stack: front-end, back-end and deployment.

This unique approach is what makes Wasp "smart" and gives it its superpowers!

For more information about Wasp, check docs.

Get started Copy Chapter

Run to install Wasp on OSX/Linux/WSL(Win):

npm i -g @wasp.sh/wasp-cli@latest

From there, follow the instructions to run your first app in less than a minute!

For a quick start, check out this docs page.

Have a Wasp app deployed? - we will send you swag! Copy Chapter

If you have a Wasp application running in production, we'd love to send some swag your way! Fill out this form, and we'll make it happen.

AI Agent Plugins Copy Chapter

Wasp has official AI agent plugins to help you kickstart your next Wasp project. You can use them with your favorite AI-assisted coding tool (Cursor, Claude Code, etc.) to get a better result and development experience. Check out the Wasp Agent Plugins page for more details.

Project status Copy Chapter

Currently, Wasp is in beta, with most features fully developed and functioning well.
However, we still have many improvements and additions in mind for the future, and we are continually working on them. As a result, you can expect numerous changes and improvements in the future.

Keep up with Wasp by following our development roadmap.

While the idea is to support multiple web tech stacks in the future, we are currently focusing on a specific stack:
React + TanStack Query, Node.js + Express.js, and Prisma.

Contributing Copy Chapter

Any way you want to contribute is a good way :)!

The best place to start is to check out waspc/, where you can find detailed steps for first-time contributors + technical details about the Wasp compiler.

The core of Wasp is built in Haskell, but there are also a lot of non-Haskell parts of Wasp, so you will certainly be able to find something for you!

Even if you don't plan to submit any code, just joining the discussion on Discord and giving your feedback is already great and helps a lot (motivates us and helps us figure out how to shape Wasp)!

You can also:

- ⭐️ Star this repo to show your interest/support.
- 📫 Stay updated by subscribing to our email list.
- 👀 Check out the development roadmap.

Careers Copy Chapter

Check our careers page for a list of currently opened positions!

Sponsors Copy Chapter

<a href="https://github.com/michelwaechter"><img src="https://github.com/michelwaechter.png" width="50px" alt="michelwaechter" /></a> - Our first sponsor ever! Thanks so much, Michel ❤️ , from the whole Wasp Team, for bravely going where nobody has been before :)!

<a href="https://github.com/shayneczyzewski"><img src="https://github.com/shayneczyzewski.png" width="50px" alt="shayneczyzewski" /></a> - Thanks Shayne, for all the contributions you did so far and for your continuous support!

<a href="https://github.com/velocity-one"><img src="https://github.com/velocity-one.png" width="50px" alt="VelocityOne" /></a> - Thanks VelocityOne for the generous donation!

<a href="https://github.com/ricdex"><img src="https://github.com/ricdex.png" width="50px" alt="ricdex" /></a> - We are thankful for your support Ricardo in this early stage of Wasp :)!

<a href="https://github.com/ThomasJonesUK"><img src="https://github.com/ThomasJonesUK.png" width="50px" alt="ThomasJonesUK" /></a> - Thanks Thomas for supporting Wasp :)!

<a href="https://github.com/Arukaito"><img src="https://github.com/Arukaito.png" width="50px" alt="Arukaito" /></a> - Our awesome sponsor again and again!

<a href="https://github.com/Case-E"><img src="https://github.com/Case-E.png" width="50px" alt="Case-E" /></a> - Big thanks for supporting us both via sponsorship and great suggestions!

Past sponsors Copy Section

<a href="https://github.com/MarianoMiguel"><img src="https://github.com/MarianoMiguel.png" width="50px" alt="MarianoMiguel" /></a>
<a href="https://github.com/Tech4Money"><img src="https://github.com/Tech4Money.png" width="50px" alt="Tech4Money" /></a>
<a href="https://github.com/haseeb-heaven"><img src="https://github.com/haseeb-heaven.png" width="50px" alt="haseeb-heaven" /></a>