Skip to content

Commit 3b2034a

Browse files
authored
Refactor repo README.md (wasp-lang#3298)
1 parent f2ee218 commit 3b2034a

File tree

1 file changed

+79
-55
lines changed

1 file changed

+79
-55
lines changed

README.md

Lines changed: 79 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
1-
<p align=center>
2-
<img height="80px" src="https://user-images.githubusercontent.com/1536647/77317442-78625700-6d0b-11ea-9822-0fb21e557e87.png"/>
3-
</p>
4-
<p align=center>
5-
The fastest way to develop full-stack web apps with React & Node.js.
6-
</p>
7-
<br>
8-
<p align=center>
9-
<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>
10-
<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>
11-
<a href="https://discord.gg/rzdnErX"><img alt="discord" src="https://img.shields.io/discord/686873244791210014?label=chat%20@%20discord"/></a>
12-
</p>
1+
<div>
2+
<!-- INTRO -->
3+
<div align=center>
4+
<img height="80px" src="https://user-images.githubusercontent.com/1536647/77317442-78625700-6d0b-11ea-9822-0fb21e557e87.png"/>
5+
<p>The fastest way to develop full-stack web apps with React & Node.js.</p>
6+
</div>
7+
<br />
8+
<!-- BADGES -->
9+
<div align=center>
10+
<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>
11+
<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>
12+
<a href="https://discord.gg/rzdnErX"><img alt="discord" src="https://img.shields.io/discord/686873244791210014?label=chat%20@%20discord"/></a>
13+
</div>
14+
<br />
15+
<!-- LINKS -->
16+
<div align=center>
17+
<a href="https://wasp.sh">Website</a>
18+
|
19+
<a href="https://wasp.sh/docs">Docs</a>
20+
</div>
21+
<div align=center>
22+
<a href="https://discord.gg/rzdnErX">Discord</a>
23+
|
24+
<a href="https://x.com/WaspLang">Twitter</a>
25+
|
26+
<a href="https://www.youtube.com/@wasplang">Youtube</a>
27+
</div>
28+
<div align=center>
29+
<a href="https://e44cy1h4s0q.typeform.com/to/EPJCwsMi">Deployed? Get swag! 👕</a>
30+
</div>
31+
</div>
1332

1433
---
1534

16-
<p align="center">
17-
<a href="https://wasp.sh">Web page</a> | <a href="https://wasp.sh/docs">Docs</a> | <a href="https://e44cy1h4s0q.typeform.com/to/EPJCwsMi">Deployed? Get swag! 👕</a>
18-
</p>
19-
20-
<br>
35+
## What is Wasp?
2136

2237
Wasp (**W**eb **A**pplication **Sp**ecification) is a Rails-like framework for React, Node.js, and Prisma.
2338
Build your app in a day and deploy it with a single CLI command!
@@ -26,11 +41,17 @@ Build your app in a day and deploy it with a single CLI command!
2641

2742
- 🚀 **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.
2843
- 😌 **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.
29-
- 🔓 **No lock-in**: You can deploy the Wasp app anywhere you like. There is no lock-in into specific providers; you have full control over the code (and can actually check it out in .wasp/ dir if you are interested ).
44+
- 🔓 **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 ).
3045

3146
### Features
3247

33-
🔒 Full-stack Auth, 🖇️ RPC (Client <-> Server), 🚀 Simple Deployment, ⚙ ️Jobs, ✉️ Email Sending, 🛟 Full-stack Type Safety, ...
48+
- [🔒 Full-stack Auth](https://wasp.sh/docs/auth/overview)
49+
- [🖇️ RPC (Client <-> Server)](https://wasp.sh/docs/data-model/operations/overview)
50+
- [🚀 Simple Deployment](https://wasp.sh/docs/deployment/deployment-methods/overview)
51+
- [⚙ ️Jobs](https://wasp.sh/docs/advanced/jobs)
52+
- [✉️ Email Sending](https://wasp.sh/docs/advanced/email)
53+
- [🛟 Full-stack Type Safety](https://wasp.sh/docs/general/typescript)
54+
- ...
3455

3556
### Code example
3657

@@ -39,25 +60,30 @@ Simple Wasp config file in which you describe the high-level details of your web
3960
```js
4061
// file: main.wasp
4162

42-
app todoApp {
43-
title: "ToDo App", // visible in the browser tab
44-
wasp: { version: "^0.15.0" },
63+
app TodoApp {
64+
title: "TODO App", // visible in the browser tab
65+
wasp: { version: "^0.18.1" },
4566
auth: { // full-stack auth out-of-the-box
46-
userEntity: User, methods: { email: {...} }
67+
userEntity: User,
68+
methods: { email: {...}, google: {...}, }
4769
}
4870
}
4971

5072
route RootRoute { path: "/", to: MainPage }
5173
page MainPage {
5274
authRequired: true, // Limit access to logged-in users.
53-
component: import Main from "@client/Main.tsx" // Your React code.
75+
component: import MainPage from "@src/MainPage" // Your React code.
5476
}
5577

5678
query getTasks {
57-
fn: import { getTasks } from "@server/tasks.js", // Your Node.js code.
79+
fn: import { getTasks } from "@src/queries", // Your Node.js code.
5880
entities: [Task] // Automatic cache invalidation.
5981
}
82+
```
83+
84+
And a Prisma schema for the database:
6085

86+
```prisma
6187
// file: schema.prisma
6288
6389
model Task { // Your Prisma data model.
@@ -67,73 +93,71 @@ model Task { // Your Prisma data model.
6793
}
6894
```
6995

70-
The rest of the code you write in React / Node.js / Prisma and just reference it from the .wasp file.
96+
The rest of the code you write in React / Node.js and reference it from the `.wasp` file.
7197

72-
:arrow_forward: Check out [TodoApp example](/examples/tutorials/TodoApp) for the complete code example. :arrow_backward:
98+
👉 Check out [TodoApp example](/examples/tutorials/TodoApp) for a complete code example. 👈
7399

74100
### How it works
75101

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

78-
Given a simple .wasp configuration file that describes the high-level details of your web app, and .js(x)/.css/..., source files with your unique logic, Wasp compiler generates the full source of your web app in the target stack: front-end, back-end and deployment.
104+
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.
79105

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

82108
For more information about Wasp, check [**docs**](https://wasp.sh/docs).
83109

84-
# Have a Wasp app deployed? - we will send you swag!
85-
86-
If you have a Wasp application running in production, we'd love to send some swag your way! Fill out [this form](https://e44cy1h4s0q.typeform.com/to/EPJCwsMi), and we'll make it happen.
110+
## Get started
87111

88-
# Get started
112+
Run to install Wasp on OSX/Linux/WSL(Win):
89113

90-
Run
91-
92-
```
114+
```sh
93115
curl -sSL https://get.wasp.sh/installer.sh | sh
94116
```
95117

96-
to install Wasp on OSX/Linux/WSL(Win). From there, just follow the instructions to run your first app in less than a minute!
118+
From there, follow the instructions to run your first app in less than a minute!
97119

98-
For more details, check out [the docs](https://wasp.sh/docs).
120+
For a quick start, check out [this docs page](https://wasp.sh/docs/quick-start).
99121

100-
# Wasp AI / Mage
122+
## Have a Wasp app deployed? - we will send you swag!
123+
124+
If you have a Wasp application running in production, we'd love to send some swag your way! Fill out [this form](https://e44cy1h4s0q.typeform.com/to/EPJCwsMi), and we'll make it happen.
101125

102-
Wasp comes with experimental AI code generator to help you kickstart your next Wasp project -> you can use it via `wasp new` in the CLI (choose "AI" option) if you can provide your OpenAI keys or you can do it via our [Mage web app](https://usemage.ai) in which case our OpenAI keys are used in the background.
126+
## Wasp AI / Mage
103127

104-
# This repository
128+
Wasp comes with experimental AI code generator to help you kickstart your next Wasp project. You can use it via `wasp new` in the CLI (select the `ai-generated` option) if you provide your OpenAI keys. Alternatively, you can use our [Mage web app](https://usemage.ai), in which case our OpenAI keys are used in the background.
105129

106-
This is the main repo of the Wasp universe, containing core code (mostly `waspc` - Wasp compiler) and the supporting materials.
130+
## Project status
107131

108-
# Project status
132+
Currently, Wasp is in beta, with most features fully developed and functioning well.
133+
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.
109134

110-
Currently, Wasp is in beta, with most features fleshed out and working well.
111-
However, there are 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.
135+
Keep up with Wasp by following [our development roadmap](https://github.com/orgs/wasp-lang/projects/5).
112136

113-
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, and Prisma.
137+
While the idea is to support multiple web tech stacks in the future, we are currently focusing on a specific stack:
138+
React + TanStack Query, Node.js + Express.js, and Prisma.
114139

115-
# Contributing
140+
## Contributing
116141

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

119-
The best place to start is to check out [waspc/](waspc/), where you can find detailed steps for first-time contributors + technical details about the Wasp compiler.
144+
The best place to start is to check out [`waspc/`](waspc/), where you can find detailed steps for first-time contributors + technical details about the Wasp compiler.
120145

121146
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!
122147

123-
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)!
148+
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)!
124149

125150
You can also:
126151

127-
- :star: Star this repo to show your interest/support.
128-
- :mailbox: Stay updated by subscribing to our [email list](https://wasp.sh#signup).
129-
- :speech_balloon: Join the discussion at https://github.com/wasp-lang/wasp/discussions .
130-
- :eyes: Check out the [development roadmap](https://github.com/orgs/wasp-lang/projects/5).
152+
- ⭐️ Star this repo to show your interest/support.
153+
- 📫 Stay updated by subscribing to our [email list](https://wasp.sh#signup).
154+
- 👀 Check out the [development roadmap](https://github.com/orgs/wasp-lang/projects/5).
131155

132-
# Careers
156+
## Careers
133157

134158
Check our [careers](https://wasp-lang.notion.site/Wasp-Careers-59fd1682c80d446f92be5fa65cc17672) page for a list of currently opened positions!
135159

136-
# Sponsors
160+
## Sponsors
137161

138162
<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 :)!
139163

@@ -149,7 +173,7 @@ Check our [careers](https://wasp-lang.notion.site/Wasp-Careers-59fd1682c80d446f9
149173

150174
<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!
151175

152-
## Past sponsors
176+
### Past sponsors
153177

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

0 commit comments

Comments
 (0)