mirror of
https://github.com/wasp-lang/wasp.git
synced 2024-08-16 10:40:35 +03:00
Renamed all references to master branch into main branch.
This commit is contained in:
parent
811fe57d63
commit
a0b7477d19
4
.github/workflows/ci.yaml
vendored
4
.github/workflows/ci.yaml
vendored
@ -1,8 +1,8 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push: { branches: [master] }
|
||||
pull_request: { branches: [master] }
|
||||
push: { branches: [main] }
|
||||
pull_request: { branches: [main] }
|
||||
create: { tags: [v*] }
|
||||
|
||||
defaults:
|
||||
|
@ -6,7 +6,7 @@
|
||||
</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/blob/main/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>
|
||||
|
@ -18,7 +18,7 @@ const WaspExampleHeader = (props) => {
|
||||
return (
|
||||
<div style={divStyle}>
|
||||
<span style={{ marginRight: "5px" }}><img alt="Wasp" src={waspLogo} height={30} /></span>
|
||||
<span>This is an example <a href="https://wasp-lang.dev" target="_blank" rel="noreferrer" style={{ color: "#fc0" }}>Wasp</a> application{props.name && ` called ${props.name}`}. To see the source, please visit our <a href="https://github.com/wasp-lang/wasp/tree/master/examples" target="_blank" rel="noreferrer" style={{ color: "#fc0" }}>GitHub repo</a>.</span>
|
||||
<span>This is an example <a href="https://wasp-lang.dev" target="_blank" rel="noreferrer" style={{ color: "#fc0" }}>Wasp</a> application{props.name && ` called ${props.name}`}. To see the source, please visit our <a href="https://github.com/wasp-lang/wasp/tree/main/examples" target="_blank" rel="noreferrer" style={{ color: "#fc0" }}>GitHub repo</a>.</span>
|
||||
<span style={{ marginLeft: "5px" }}>🚀</span>
|
||||
</div>
|
||||
)
|
||||
|
@ -37,7 +37,7 @@ We use [Stack](https://docs.haskellstack.org/en/stable/README/) for building the
|
||||
### Repo
|
||||
Fork this repo and clone the fork to your machine (or clone this repo directly if you don't plan to contribute but just want to try it out).
|
||||
|
||||
Position yourself in this directory (`waspc/`) and make sure that you are on the `master` branch.
|
||||
Position yourself in this directory (`waspc/`) and make sure that you are on the `main` branch.
|
||||
|
||||
### Build
|
||||
```
|
||||
@ -104,7 +104,7 @@ NOTE: Reload page if blank.
|
||||
|
||||
|
||||
## Typical development workflow
|
||||
1. Create a new feature branch from `master`.
|
||||
1. Create a new feature branch from `main`.
|
||||
2. Run `./run ghcid` from the root of the project: this will run a process that watches the Haskell project and reports any Haskell compiler errors. Leave it running.
|
||||
NOTE: You will need to install `ghcid` globally first, you can do it with `stack install ghcid`.
|
||||
3. Do a change in the codebase (most often in `lib/` or `cli/` or `data/`) (together with tests if that makes sense: see "Tests").
|
||||
@ -118,7 +118,7 @@ NOTE: Reload page if blank.
|
||||
7. If your PR changes how users(Waspers) use Wasp, make sure to also create a PR that will update the documentation, which is in a [separate repo](https://wasp-lang.dev/docs/tutorials/getting-started).
|
||||
8. Work with reviewer(s) to get the PR approved.
|
||||
Keep adding "fix" commits until PR is approved, then again squash them all into one commit.
|
||||
9. Reviewer will merge the branch into `master`. Yay!
|
||||
9. Reviewer will merge the branch into `main`. Yay!
|
||||
|
||||
## Design docs (aka RFCs)
|
||||
If the feature you are implementing is complex, be it regarding its design or technical implementation, we recommend creating a [design doc](https://www.industrialempathy.com/posts/design-docs-at-google/) (aka RFC).
|
||||
@ -290,7 +290,7 @@ We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta
|
||||
## Deployment / CI
|
||||
We use Github Actions for CI.
|
||||
|
||||
CI runs for any commits on `master` branch, for pull requests, and for any commits tagged with tag that starts with `v`.
|
||||
CI runs for any commits on `main` branch, for pull requests, and for any commits tagged with tag that starts with `v`.
|
||||
|
||||
During CI, we build and test Wasp code on Linux, MacOS and Windows.
|
||||
|
||||
|
@ -76,7 +76,7 @@ entity User {=psl
|
||||
psl=}
|
||||
```
|
||||
|
||||
Check [here](https://github.com/wasp-lang/wasp/blob/master/examples/tutorials/TodoApp/main.wasp) for the complete example.
|
||||
Check [here](https://github.com/wasp-lang/wasp/blob/main/examples/tutorials/TodoApp/main.wasp) for the complete example.
|
||||
|
||||
## Why a language (DSL), aren’t frameworks solving this already?
|
||||
|
||||
|
@ -16,7 +16,7 @@ import ImgWithCaption from './components/ImgWithCaption'
|
||||
![Enter Waspello](../static/img/waspello-screenshot.png)
|
||||
|
||||
<p align="center">
|
||||
<Link to={'https://waspello.netlify.app/'}>Try Waspello here!</Link> | <Link to={'https://github.com/wasp-lang/wasp/blob/master/examples/waspello/main.wasp'}>See the code</Link>
|
||||
<Link to={'https://waspello.netlify.app/'}>Try Waspello here!</Link> | <Link to={'https://github.com/wasp-lang/wasp/blob/main/examples/waspello/main.wasp'}>See the code</Link>
|
||||
</p>
|
||||
|
||||
<WaspIntro />
|
||||
@ -126,7 +126,7 @@ export const getListsAndCards = async (args, context) => {
|
||||
```
|
||||
This is just a regular Node.js function, there are no limits on what you can return! All the stuff provided by Wasp (user data, Prisma SDK for a specific entity) comes in a `context` variable.
|
||||
|
||||
The code for actions is very similar (we just need to use `action` keyword instead of `query`) so I won't repeat it here. You can check out the code for `updateCard` action [here](https://github.com/wasp-lang/wasp/blob/master/examples/waspello/main.wasp#L103).
|
||||
The code for actions is very similar (we just need to use `action` keyword instead of `query`) so I won't repeat it here. You can check out the code for `updateCard` action [here](https://github.com/wasp-lang/wasp/blob/main/examples/waspello/main.wasp#L103).
|
||||
|
||||
#### Pages, routing & components
|
||||
To display all the nice data we have, we'll use React components. There are no limits to how you can use React components within Wasp, the only one is that each `page` has its root component:
|
||||
|
@ -16,7 +16,7 @@ import ImgWithCaption from './components/ImgWithCaption'
|
||||
![Hello, Waspleau](../static/img/waspleau-screenshot.png)
|
||||
|
||||
<p align="center">
|
||||
<Link to={'https://waspleau.netlify.app/'}>See Waspleau here!</Link> | <Link to={'https://github.com/wasp-lang/wasp/blob/master/examples/waspleau'}>See the code</Link>
|
||||
<Link to={'https://waspleau.netlify.app/'}>See Waspleau here!</Link> | <Link to={'https://github.com/wasp-lang/wasp/blob/main/examples/waspleau'}>See the code</Link>
|
||||
</p>
|
||||
|
||||
<WaspIntro />
|
||||
@ -122,7 +122,7 @@ const workerFunction = async (opts) => {
|
||||
export const githubWorker = { name: 'GitHub API', fn: workerFunction, schedule: '*/10 * * * *' }
|
||||
```
|
||||
|
||||
_Note: Please see the [actual serverSetup.js file](https://github.com/wasp-lang/wasp/blob/master/examples/waspleau/ext/serverSetup.js) for how we use this abstraction in practice._
|
||||
_Note: Please see the [actual serverSetup.js file](https://github.com/wasp-lang/wasp/blob/main/examples/waspleau/ext/serverSetup.js) for how we use this abstraction in practice._
|
||||
|
||||
### Server → client
|
||||
|
||||
@ -163,7 +163,7 @@ const { data: dashboardData, isFetching, error } = useQuery(refreshDashboardData
|
||||
|
||||
## Congratulations, let’s dance!
|
||||
|
||||
Whew, we did it! If you’d like to deploy your own customized version of this dashboard, please clone [our repo](https://github.com/wasp-lang/wasp) and check out the Waspleau example [README.md](https://github.com/wasp-lang/wasp/blob/master/examples/waspleau/README.md) for tips on getting started. You can also [check out our docs](https://wasp-lang.dev/docs) to dive deeper into anything.
|
||||
Whew, we did it! If you’d like to deploy your own customized version of this dashboard, please clone [our repo](https://github.com/wasp-lang/wasp) and check out the Waspleau example [README.md](https://github.com/wasp-lang/wasp/blob/main/examples/waspleau/README.md) for tips on getting started. You can also [check out our docs](https://wasp-lang.dev/docs) to dive deeper into anything.
|
||||
|
||||
![Rickroll](../static/img/waspleau-rickroll.gif)
|
||||
|
||||
|
@ -9,4 +9,4 @@ Any way you want to contribute is a good way, and we are happy to meet you :)!
|
||||
Some typical ways to contribute:
|
||||
1. Join us on discord [![Discord](https://img.shields.io/discord/686873244791210014?label=chat%20on%20discord)](https://discord.gg/rzdnErX) and let's talk! We can discuss language design, new/existing features, weather, or you can just tell us how you feel about Wasp :).
|
||||
2. If there is something in docs that you think could be improved or clarified, go to [docs Github repo](https://github.com/wasp-lang/wasp) and make an issue/PR! Or, you can do it directly from here by clicking on "edit this page" at the bottom of each page.
|
||||
3. Create an issue/PR on [core Wasp repo](https://github.com/wasp-lang/wasp) to contribute directly to the language and/or compiler! Check [wapsc README](https://github.com/wasp-lang/wasp/tree/master/waspc) for more details.
|
||||
3. Create an issue/PR on [core Wasp repo](https://github.com/wasp-lang/wasp) to contribute directly to the language and/or compiler! Check [wapsc README](https://github.com/wasp-lang/wasp/tree/main/waspc) for more details.
|
||||
|
@ -3,8 +3,8 @@ title: Examples
|
||||
---
|
||||
|
||||
Todo App:
|
||||
- source code: https://github.com/wasp-lang/wasp/tree/master/examples/tutorials/TodoApp .
|
||||
- source code: https://github.com/wasp-lang/wasp/tree/main/examples/tutorials/TodoApp .
|
||||
|
||||
Real World App (clone of Medium):
|
||||
- source code: https://github.com/wasp-lang/wasp/tree/master/examples/realworld .
|
||||
- source code: https://github.com/wasp-lang/wasp/tree/main/examples/realworld .
|
||||
- hosted at: https://wasp-rwa.netlify.app/ .
|
||||
|
@ -91,7 +91,7 @@ To install from source, you need to clone the [wasp repo](https://github.com/was
|
||||
|
||||
If you have never built Wasp before, this might take some time due to `stack` downloading dependencies for the first time.
|
||||
|
||||
Check [waspc/](https://github.com/wasp-lang/wasp/tree/master/waspc) for more details on building.
|
||||
Check [waspc/](https://github.com/wasp-lang/wasp/tree/main/waspc) for more details on building.
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
|
@ -51,6 +51,6 @@ entity Task {=psl
|
||||
psl=}
|
||||
```
|
||||
|
||||
You can check out a full working example [here](https://github.com/wasp-lang/wasp/tree/master/waspc/examples/todoApp).
|
||||
You can check out a full working example [here](https://github.com/wasp-lang/wasp/tree/main/waspc/examples/todoApp).
|
||||
|
||||
In the following sections each of the basic language features is explained.
|
||||
|
@ -43,7 +43,7 @@ Wasp's type system can be divided into two main categories of types: **fundament
|
||||
|
||||
While fundamental types are here to be basic building blocks of a language, and are very similar to what you would see in other popular lanuages, domain types are what makes Wasp special, as they model the concepts of a web app like `page`, `route` and similar.
|
||||
|
||||
- Fundamental types ([source of truth](https://github.com/wasp-lang/wasp/blob/master/waspc/src/Wasp/Analyzer/Type.hs))
|
||||
- Fundamental types ([source of truth](https://github.com/wasp-lang/wasp/blob/main/waspc/src/Wasp/Analyzer/Type.hs))
|
||||
- Primitive types
|
||||
- **string** (`"foo"`, `"they said: \"hi\""`)
|
||||
- **bool** (`true`, `false`)
|
||||
@ -60,7 +60,7 @@ While fundamental types are here to be basic building blocks of a language, and
|
||||
- **list** (`[1, 2, 3]`)
|
||||
- **tuple** (`(1, "bar")`, `(2, 4, true)`)
|
||||
- Tuples can be of size 2, 3 and 4.
|
||||
- Domain types ([source of truth](https://github.com/wasp-lang/wasp/blob/master/waspc/src/Wasp/Analyzer/StdTypeDefinitions.hs))
|
||||
- Domain types ([source of truth](https://github.com/wasp-lang/wasp/blob/main/waspc/src/Wasp/Analyzer/StdTypeDefinitions.hs))
|
||||
- Declaration types
|
||||
- **app**
|
||||
- **page**
|
||||
|
@ -22,7 +22,7 @@ This tutorial will take you step by step through the most important features of
|
||||
|
||||
If you get stuck at any point (or just want to chat), reach out to us on [Discord](https://discord.gg/rzdnErX) and we will help you!
|
||||
|
||||
You can check out the complete code of the app we are about to build with Wasp [here](https://github.com/wasp-lang/wasp/tree/master/examples/tutorials/TodoApp).
|
||||
You can check out the complete code of the app we are about to build with Wasp [here](https://github.com/wasp-lang/wasp/tree/main/examples/tutorials/TodoApp).
|
||||
|
||||
:::tip
|
||||
If you are interested at any moment in what is Wasp actually generating in the background, take a look at `.wasp/out/` directory in your project.
|
||||
|
@ -11,7 +11,7 @@ We did it! For all those that followed the instructions closely and created "Bui
|
||||
style={{ border: '1px solid black' }}
|
||||
/>
|
||||
|
||||
You can check out the whole code of the app that we just built [here](https://github.com/wasp-lang/wasp/tree/master/examples/tutorials/TodoApp).
|
||||
You can check out the whole code of the app that we just built [here](https://github.com/wasp-lang/wasp/tree/main/examples/tutorials/TodoApp).
|
||||
|
||||
If you are interested in what is Wasp actually generating in the background, you can check `.wasp/out/` directory in your project.
|
||||
|
||||
|
@ -118,13 +118,13 @@ module.exports = {
|
||||
sidebarCollapsible: true,
|
||||
// Please change this to your repo.
|
||||
editUrl:
|
||||
'https://github.com/wasp-lang/wasp/edit/master/web',
|
||||
'https://github.com/wasp-lang/wasp/edit/main/web',
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
// Please change this to your repo.
|
||||
editUrl:
|
||||
'https://github.com/wasp-lang/wasp/edit/master/web/blog',
|
||||
'https://github.com/wasp-lang/wasp/edit/main/web/blog',
|
||||
},
|
||||
theme: {
|
||||
customCss: [
|
||||
|
@ -747,7 +747,7 @@ function Home() {
|
||||
|
||||
<div className={clsx('row', styles.responsiveCentered)}>
|
||||
<div className="col col--10 col--offset-1">
|
||||
<h3>You can try out the deployed app <a href={waspRwaDemoUrl}>here</a> or check out the source code <a href="https://github.com/wasp-lang/wasp/tree/master/examples/realworld">here</a>.</h3>
|
||||
<h3>You can try out the deployed app <a href={waspRwaDemoUrl}>here</a> or check out the source code <a href="https://github.com/wasp-lang/wasp/tree/main/examples/realworld">here</a>.</h3>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user