mirror of
https://github.com/wasp-lang/wasp.git
synced 2024-12-25 18:13:52 +03:00
94 lines
4.5 KiB
Markdown
94 lines
4.5 KiB
Markdown
<p align=center>
|
|
<img height="80px" src="https://user-images.githubusercontent.com/1536647/77317442-78625700-6d0b-11ea-9822-0fb21e557e87.png"/>
|
|
</p>
|
|
<p align=center>
|
|
A programming language that understands what a web app is.
|
|
</p>
|
|
<br>
|
|
<p align=center>
|
|
<a href="https://github.com/wasp-lang/wasp/blob/master/LICENSE"><img alt="license" src="https://img.shields.io/github/license/wasp-lang/wasp"></a>
|
|
<a href="https://github.com/wasp-lang/wasp/search?l=haskell"><img alt="language" src="https://img.shields.io/badge/language-Haskell-purple.svg"></a>
|
|
<a href="https://github.com/wasp-lang/wasp/actions"><img alt="build status" src="https://img.shields.io/github/workflow/status/wasp-lang/wasp/CI"/></a>
|
|
<a href="https://discord.gg/rzdnErX"><img alt="discord" src="https://img.shields.io/discord/686873244791210014?label=chat%20@%20discord"/></a>
|
|
</p>
|
|
|
|
------
|
|
|
|
- [**Project page**](https://wasp-lang.dev)
|
|
- [**Docs**](https://wasp-lang.dev/docs)
|
|
|
|
<br>
|
|
|
|
Wasp (**W**eb **A**pplication **Sp**ecification Language) is an extensible [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) (domain-specific language) for building modern web apps with less code.
|
|
|
|
Concepts such as *app*, *page*, *user*, *login*, *frontend*, *production*, etc. are baked into the language, bringing a new level of expressiveness and allowing you to get more work done with fewer lines of code.
|
|
|
|
NOTE: Wasp is still in alpha, meaning it has bugs, and many critical features are still missing and it is still changing a lot!
|
|
|
|
```js
|
|
// todoApp.wasp:
|
|
|
|
app TodoApp {
|
|
title: "ToDo app",
|
|
favicon: "./todo-logo.png"
|
|
}
|
|
|
|
route "/" -> page Main
|
|
page Main {
|
|
component: import Main from "@ext/pages/Main"
|
|
}
|
|
|
|
query getTasks {
|
|
fn: import { getTasks } from "@ext/queries.js"
|
|
}
|
|
|
|
entity Task {=psl
|
|
id Int @id @default(autoincrement())
|
|
description String
|
|
isDone Boolean @default(false)
|
|
psl=}
|
|
```
|
|
|
|
Source files (`.wasp`, `.js(x)`, `.css`, ...) are compiled (transpiled) by `waspc` (Wasp compiler) into the web technology stack of your choice (e.g. React + Redux + ExpressJS + ...).
|
|
|
|
:arrow_forward: Check out [TodoApp example](waspc/examples/todoApp) for complete code example. :arrow_backward:
|
|
|
|
Why is Wasp awesome:
|
|
- **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.
|
|
- **Flexible**: When you need more control than Wasp offers, you can write code in existing technologies such as js/html/css/... and combine it with Wasp code!
|
|
- **No lock-in**: If Wasp becomes too limiting for you, simply eject and continue with the generated source code, which is human-readable.
|
|
|
|
For more information about Wasp, check [**docs**](https://wasp-lang.dev/docs).
|
|
|
|
# Get started
|
|
Check out [the docs](https://wasp-lang.dev/docs/tutorials/getting-started).
|
|
|
|
# This repository
|
|
|
|
This is the main repo of the Wasp universe, containing core code (mostly `waspc` - Wasp compiler) and the supporting materials.
|
|
|
|
# Project status
|
|
|
|
Currently, Wasp is in alpha and has enough features so that you can develop a basic web app in it!
|
|
You might find that it misses flexibility in some places or that some bigger features are missing, but the basics are there and we are not adding on top of them.
|
|
In the case you get stuck, you can take the generated code and continue with it.
|
|
As Wasp grows further, it should allow the development of web apps of increasing complexity, without the need to eject!
|
|
|
|
While the idea is to support multiple web tech stacks in the future, right now we are focusing on the specific stack: React + react-query, NodeJS + ExpressJS, Prisma. We might yet change that as time goes, taking trends into account, but for now, this is serving us well for the purpose of developing compiler and language.
|
|
|
|
# Contributing
|
|
|
|
Any way you want to contribute is a good way :)!
|
|
|
|
The best place to start is to check out [waspc/](waspc/), where you can find detailed steps for the first time contributors + technical details about the Wasp compiler.
|
|
|
|
Even if you don't plan to submit any code, just joining the discussion on discord [](https://discord.gg/rzdnErX) 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: Star this repo to show your interest/support.
|
|
- :mailbox: Stay updated by subscribing to our [email list](https://wasp-lang.dev#signup).
|
|
|
|
# FAQ
|
|
|
|
Check out https://wasp-lang.dev/#faq.
|