wasp/README.md

106 lines
4.9 KiB
Markdown
Raw Normal View History

2020-03-23 15:47:08 +03:00
<p align=center>
<img height="80px" src="https://user-images.githubusercontent.com/1536647/77317442-78625700-6d0b-11ea-9822-0fb21e557e87.png"/>
</p>
2020-11-12 09:02:43 +03:00
<p align=center>
A programming language that understands what a web app is.
</p>
2020-01-31 17:18:09 +03:00
<br>
2020-11-12 09:02:43 +03:00
<p 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>
2020-11-12 09:02:43 +03:00
<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>
2020-01-31 17:18:09 +03:00
2020-11-12 09:02:43 +03:00
------
2020-01-31 17:18:09 +03:00
2021-10-04 17:10:34 +03:00
<p align="center">
{= <a href="https://wasp-lang.notion.site/Wasp-Careers-59fd1682c80d446f92be5fa65cc17672">We are hiring!</a> =}
</p>
2020-09-22 14:52:16 +03:00
- [**Project page**](https://wasp-lang.dev)
- [**Docs**](https://wasp-lang.dev/docs)
2020-03-23 15:47:08 +03:00
<br>
2021-02-09 21:57:31 +03:00
Wasp (**W**eb **A**pplication **Sp**ecification Language) is a declarative DSL (domain-specific language) for developing, building and deploying modern full-stack web apps with less code.
2020-01-31 17:18:09 +03:00
2020-02-07 19:20:41 +03:00
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.
2020-01-31 17:18:09 +03:00
2021-02-09 21:57:31 +03:00
While describing high-level features with Wasp, you still write the rest of your logic in your favorite technologies (currently React, NodeJS, Prisma).
2020-09-22 14:52:16 +03:00
2020-01-31 17:18:09 +03:00
```js
2021-02-09 21:57:31 +03:00
// file: main.wasp
2020-01-31 17:18:09 +03:00
app TodoApp {
2022-11-23 16:33:18 +03:00
title: "Todo App",
wasp: { version: "^0.7.0" }
2020-01-31 17:18:09 +03:00
}
route RootRoute { path: "/", to: MainPage }
page MainPage {
component: import Main from "@ext/pages/Main.js" // Importing React component.
2020-01-31 17:18:09 +03:00
}
2020-09-22 14:52:16 +03:00
query getTasks {
2021-02-09 21:57:31 +03:00
fn: import { getTasks } from "@ext/queries.js", // Importing NodeJS code.
entities: [Task]
2020-01-31 17:18:09 +03:00
}
2020-10-21 17:37:20 +03:00
entity Task {=psl
2020-09-22 14:52:16 +03:00
id Int @id @default(autoincrement())
description String
isDone Boolean @default(false)
psl=}
2020-01-31 17:18:09 +03:00
```
2021-02-09 21:57:31 +03:00
Source files (`.wasp`, `.js(x)`, `.css`, ...) are compiled by `waspc` (Wasp compiler) into the web technology stack of your choice (currently React + NodeJS/ExpressJS + Prisma).
2020-01-31 17:18:09 +03:00
2021-02-10 23:41:09 +03:00
:arrow_forward: Check out [TodoApp example](/examples/tutorials/TodoApp) for the complete code example. :arrow_backward:
2020-01-31 17:18:09 +03:00
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!
2020-09-22 14:52:16 +03:00
- **No lock-in**: If Wasp becomes too limiting for you, simply eject and continue with the generated source code, which is human-readable.
2020-01-31 17:18:09 +03:00
For more information about Wasp, check [**docs**](https://wasp-lang.dev/docs).
2020-01-31 17:18:09 +03:00
2020-02-07 18:27:35 +03:00
# Get started
2021-02-09 21:57:31 +03:00
Run
```
curl -sSL https://get.wasp-lang.dev/installer.sh | sh
2021-02-09 21:57:31 +03:00
```
to install Wasp on OSX/Linux. From there, just follow the instructions to run your first app in less then a minute!
For more details (including installing on Windows) check out [the docs](https://wasp-lang.dev/docs).
2020-01-31 17:18:09 +03:00
# This repository
2020-02-20 16:32:03 +03:00
This is the main repo of the Wasp universe, containing core code (mostly `waspc` - Wasp compiler) and the supporting materials.
2020-01-31 17:18:09 +03:00
# Project status
2022-11-23 16:33:18 +03:00
Currently, Wasp is in beta, with most features flushed out and working well.
However, there is still a lot of improvements and additions that we have in mind for the future, and we are working on them constantly, so you can expect a lot of changes and improvements in the future.
As Wasp grows further, it should allow the development of web apps of increasing complexity!
2020-01-31 17:18:09 +03:00
2020-09-22 14:52:16 +03:00
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.
2020-01-31 17:18:09 +03:00
# Contributing
2020-02-20 16:32:03 +03:00
Any way you want to contribute is a good way :)!
2020-11-05 20:44:03 +03:00
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.
2020-02-20 16:32:03 +03:00
2020-11-05 20:44:03 +03:00
Even if you don't plan to submit any code, just joining the discussion on discord [![Discord](https://img.shields.io/discord/686873244791210014?label=chat%20on%20discord)](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)!
2020-01-31 17:18:09 +03:00
2020-02-20 16:32:03 +03:00
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).
2021-10-04 17:12:31 +03:00
# Careers
Check our [careers](https://wasp-lang.notion.site/Wasp-Careers-59fd1682c80d446f92be5fa65cc17672) page for a list of currently opened positions!