mirror of
https://github.com/wasp-lang/wasp.git
synced 2024-09-11 15:26:19 +03:00
First version of informative README.
This commit is contained in:
Martin Sosic
parent
c246a54e0b
commit
985372e1de
117
README.md
117
README.md
@ -1,2 +1,115 @@
|
||||
# wasp
|
||||
A programming language that understands what a web app is.
|
||||
```
|
||||
_ _
|
||||
__ ____ _ ___ _ __ | )/ )
|
||||
\ \ /\ / / _` / __| '_ \ \\ |//,' __
|
||||
\ V V / (_| \__ \ |_) | (")(_)-"()))=-
|
||||
\_/\_/ \__,_|___/ .__/ (\\
|
||||
|_|
|
||||
```
|
||||
|
||||
|
||||
|
||||
<p align=center> A programming language that understands what a web app is. </p>
|
||||
<br>
|
||||
|
||||
[](https://gitter.im/wasp-lang/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||||
|
||||
<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.
|
||||
|
||||
This means that 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.
|
||||
|
||||
```js
|
||||
// todoApp.wasp:
|
||||
|
||||
app TodoApp {
|
||||
title: "ToDo app",
|
||||
favicon: "./todo-logo.png"
|
||||
}
|
||||
|
||||
entity Task {
|
||||
description :: string,
|
||||
isDone :: boolean
|
||||
}
|
||||
|
||||
entity-list<Task> TaskList {
|
||||
editable: true
|
||||
}
|
||||
|
||||
page Main {
|
||||
route: "/",
|
||||
content: {=jsx
|
||||
<h1>Todos</h1>
|
||||
<TaskList/>
|
||||
jsx=},
|
||||
style: "./main.css"
|
||||
}
|
||||
|
||||
...
|
||||
```
|
||||
|
||||
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 + ...).
|
||||
|
||||
Check out [TodoApp example](examples/todoApp) for complete code example.
|
||||
|
||||
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 that follows industry best-practices, as if it was handwritten by a senior engineer.
|
||||
|
||||
For more of general information about Wasp, check:
|
||||
- **The main webpage**: [https://wasp-lang.dev].
|
||||
- [**Blog**](https://blog.wasp-lang.dev/): [Why are we building Wasp?](https://blog.wasp-lang.dev/posts/2019-09-01-hello-wasp.html)
|
||||
|
||||
If you are interested/excited about Wasp, **support us by giving us a star :star: and/or [subscribe](https://wasp-lang.dev#signup) to our email list :mailbox:**! Check [Contributing](#contributing) for more information.
|
||||
|
||||
|
||||
# This repository
|
||||
|
||||
This is the main repo of the Wasp universe, containing core code (not yet at the moment, but `waspc` (Wasp compiler) code is coming soon) and the supporting materials.
|
||||
|
||||
|
||||
# Documentation
|
||||
|
||||
While we do plan to publish detailed documentation, we don't have anything worth publishing yet due to how fast everything is changing in this early stage of Wasp development.
|
||||
|
||||
In the meantime, the best way to learn more is by taking a look at our [TodoApp example](examples/todoApp).
|
||||
|
||||
|
||||
# Project status
|
||||
|
||||
We are still early and are doing closed development iterations with our early adopters.
|
||||
|
||||
Specifically, we are developing `waspc` (Wasp compiler) and also designing language as we go.
|
||||
|
||||
Currently, `waspc` is in a state where the main parts are there (code analysis and generation) and we are successfully generating code as can be seen at [TodoApp example](examples/todoApp).
|
||||
|
||||
The language itself supports a narrow set of features for now, not enough for serious web app development, but we believe it is a good basis to build upon.
|
||||
The next step is to expand the language (and compiler) so it can serve the role of a powerful code generator - it will still not have enough features to keep you from ejecting for a very long time, but it will be enough to give you a quick start.
|
||||
Finally, as it 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 + Redux, NodeJS + ExpressJS, Mongo. 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
|
||||
|
||||
Since we are still doing closed development of the very first version of the compiler (`waspc`) and language (check [Project status](#project-status) for more info), you can't contribute to the code directly via this repository at the moment.
|
||||
|
||||
However, even more than help with development, at this early stage we need your support and feedback! You can help us greatly by:
|
||||
- :star: **Starring this repository**.
|
||||
- :mailbox: Staying updated by **subscribing to our email list** at [wasp-lang.dev](https://wasp-lang.dev#signup).
|
||||
- :speech_balloon: **Providing feedback and ideas** via gitter [](https://gitter.im/wasp-lang/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge).
|
||||
Also let us know if you would like to be more closely involved, as we are looking for developers to participate with us in designing/testing the closed version of Wasp before we open it.
|
||||
|
||||
Your support and feedback are hugely important for us because they tell us (and others) that what we are building is something people want, and it also helps us better understand what that is :)!
|
||||
|
||||
|
||||
# FAQ
|
||||
|
||||
Check out https://wasp-lang.dev/#faq.
|
||||
|
||||
|
||||
# Other
|
||||
|
||||
Wasp ASCII art used in the title is from https://www.asciiart.eu/animals/insects/bees, author: Stef00.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
Each example has src/ and out/ directory, where out/ is code generated by `waspc` from src/.
|
||||
Each example has `src/` and `out/` directory, where `out/` is code generated by `waspc` from `src/`.
|
||||
|
||||
Examples are deployed to https://examples.wasp-lang.dev.
|
||||
|
||||
@ -6,4 +6,4 @@ NOTE: Right now, there is only one example, and it is deployed directly to https
|
||||
Plan is, when we will have more examples, to deploy them next to each other, each in its own directory, so they would be accessed as https://examples.wasp-lang.dev/todoApp and so on.
|
||||
But, for that we need support in Wasp for the scenario where frontend is not hosted at server root, which we don't support yet.
|
||||
|
||||
Check `Makefile` for build / deploy commands.
|
||||
Check `Makefile` for build / deploy commands.
|
||||
|
||||
7
examples/todoApp/README.md
Normal file
7
examples/todoApp/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
In this example we use Wasp to implement a simple Todo app, inspired by http://todomvc.com.
|
||||
|
||||
Code in [src/](src/) (todoApp.wasp + [src/src](src/src)) is compiled by `waspc`, generating code in [out/](out/), which is frontend only web app. There was no manual intervention in the generated code, it is as generated by `waspc`.
|
||||
|
||||
Command used: `waspc src/todoApp.wasp out/`.
|
||||
|
||||
You can check out deployed generated app at https://examples.wasp-lang.dev.
|
||||
1
waspc/README.md
Normal file
1
waspc/README.md
Normal file
@ -0,0 +1 @@
|
||||
Coming soon! Check [Project status](../README.md#project-status) for more details.
|
||||
Loading…
Reference in New Issue
Block a user