mirror of
https://github.com/wasp-lang/open-saas.git
synced 2025-11-22 05:09:48 +01:00
57 lines
2.7 KiB
Plaintext
57 lines
2.7 KiB
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: true
|
|
---
|
|
# 1. Wasp Overview and Core Concepts
|
|
|
|
This document covers the fundamental concepts of the Wasp framework and the basic project structure.
|
|
|
|
## Background Information
|
|
|
|
### What is Wasp
|
|
|
|
- Wasp (Web Application SPecification language) is a declarative, statically typed, domain-specific language (DSL) for building modern, full-stack web applications.
|
|
- Unlike traditional frameworks that are sets of libraries, Wasp is a simple programming language that understands web app concepts and generates code for you.
|
|
- Wasp integrates with React (frontend), Node.js (backend), and Prisma (database ORM) to create full-stack web applications with minimal boilerplate.
|
|
- The Wasp compiler reads your declarative configuration in the config file ([main.wasp](mdc:main.wasp) or `main.wasp.ts`) and generates all the necessary code for a working web application.
|
|
- For the most up-to-date and comprehensive information, always refer to the Wasp Documenation (linked below).
|
|
|
|
### Wasp Project Structure
|
|
|
|
- A Wasp project consists of a [main.wasp](mdc:main.wasp) (or `main.wasp.ts`) file in the root directory that defines the app's configuration.
|
|
- The [schema.prisma](mdc:schema.prisma) file in the root directory defines your database models ("entities").
|
|
- Your custom code lives in the `src/` directory (e.g. `src/{featureName}`), which contains client-side and server-side code.
|
|
- Wasp generates additional code that connects everything together when you run your app.
|
|
|
|
### The Wasp Config File
|
|
|
|
- The main Wasp Config File ([main.wasp](mdc:main.wasp) or `main.wasp.ts`) is the central configuration file that defines your application structure.
|
|
- It contains declarations for app settings, pages, routes, authentication, database entities, and operations (queries and actions).
|
|
- Example structure:
|
|
```main.wasp
|
|
app myApp {
|
|
wasp: {
|
|
version: "^0.16.0" // Check @main.wasp for the actual version
|
|
},
|
|
title: "My App",
|
|
}
|
|
|
|
route HomeRoute { path: "/", to: HomePage }
|
|
page HomePage {
|
|
component: import { HomePage } from "@src/client/pages/HomePage.tsx" // Example import path
|
|
}
|
|
|
|
// Operations are defined here, see 3-database-operations.mdc
|
|
query getTasks {
|
|
fn: import { getTasks } from "@src/server/queries.js",
|
|
entities: [Task]
|
|
}
|
|
```
|
|
|
|
### Wasp Documentation
|
|
More info on all of Wasp's features can be found in the Wasp documentation (NOTE: You can follow these links, instruct the user to add these docs to Cursor's settings, or have the user manually include them in the chat context):
|
|
- Links to Wasp documentation sections (LLM-optimized): https://wasp.sh/llms.txt
|
|
- Complete Wasp documentation (LLM-optimized): https://wasp.sh/llms-full.txt
|
|
- Wasp Docs homepage (human-readable): https://wasp.sh/docs
|