mirror of
https://github.com/wasp-lang/wasp.git
synced 2024-12-25 10:03:07 +03:00
Fixes typos in docs (#1911)
This commit is contained in:
parent
f255fb834c
commit
b0e1c6ce99
@ -238,7 +238,7 @@ If you are deploying an app that requires any other environment variables (like
|
||||
wasp deploy fly cmd secrets set GOOGLE_CLIENT_ID=<...> GOOGLE_CLIENT_SECRET=<...> --context=server
|
||||
```
|
||||
|
||||
### Mutliple Fly Organizations
|
||||
### Multiple Fly Organizations
|
||||
|
||||
If you have multiple organizations, you can specify a `--org` option. For example:
|
||||
|
||||
|
@ -64,7 +64,7 @@ Here are the environment variables your server will be looking for:
|
||||
|
||||
- `DATABASE_URL` <Required />
|
||||
|
||||
The URL of the Postgres database you want your app to use (e.g., `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`).
|
||||
The URL of the PostgreSQL database you want your app to use (e.g., `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`).
|
||||
|
||||
- `WASP_WEB_CLIENT_URL` <Required />
|
||||
|
||||
@ -154,7 +154,7 @@ flyctl launch --remote-only
|
||||
|
||||
This will ask you a series of questions, such as asking you to choose a region and whether you'd like a database.
|
||||
|
||||
- Say **yes** to **Would you like to set up a Postgresql database now?** and select **Development**. Fly.io will set a `DATABASE_URL` for you.
|
||||
- Say **yes** to **Would you like to set up a PostgreSQL database now?** and select **Development**. Fly.io will set a `DATABASE_URL` for you.
|
||||
- Say **no** to **Would you like to deploy now?** (and to any additional questions).
|
||||
|
||||
We still need to set up several environment variables.
|
||||
@ -330,8 +330,8 @@ Let's deploy our server first:
|
||||
Open the `Settings` and go to the `Variables` tab:
|
||||
|
||||
- click **Variable reference** and select `DATABASE_URL` (it will populate it with the correct value)
|
||||
- add `WASP_WEB_CLIENT_URL` - enter the the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
|
||||
- add `WASP_SERVER_URL` - enter the the `server` domain (e.g. `https://server-production-XXXX.up.railway.app`)
|
||||
- add `WASP_WEB_CLIENT_URL` - enter the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
|
||||
- add `WASP_SERVER_URL` - enter the `server` domain (e.g. `https://server-production-XXXX.up.railway.app`)
|
||||
- add `JWT_SECRET` - enter a random string at least 32 characters long (use an [online generator](https://djecrety.ir/))
|
||||
|
||||
<AddExternalAuthEnvVarsReminder />
|
||||
@ -461,7 +461,7 @@ railway up
|
||||
|
||||
And now your Wasp should be deployed! 🐝 🚂 🚀
|
||||
|
||||
Back in your [Railway dashboard](https://railway.app/dashboard), click on your project and you should see your newly deployed services: Postgres, Server, and Client.
|
||||
Back in your [Railway dashboard](https://railway.app/dashboard), click on your project and you should see your newly deployed services: PostgreSQL, Server, and Client.
|
||||
|
||||
### Updates & Redeploying
|
||||
|
||||
@ -497,7 +497,7 @@ Unless you want to deploy to an existing Heroku app, let's create a new Heroku a
|
||||
heroku create <app-name>
|
||||
```
|
||||
|
||||
Unless you have an external Postgres database that you want to use, let's create a new database on Heroku and attach it to our app:
|
||||
Unless you have an external PostgreSQL database that you want to use, let's create a new database on Heroku and attach it to our app:
|
||||
|
||||
```
|
||||
heroku addons:create --app <app-name> heroku-postgresql:mini
|
||||
|
@ -127,7 +127,7 @@ Let's write an example Job that will print a message to the console and return a
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
And that'is it. Your job will be executed by `PgBoss` as if you called `foo({ name: "Johnny" })`.
|
||||
And that's it. Your job will be executed by `PgBoss` as if you called `foo({ name: "Johnny" })`.
|
||||
|
||||
In our example, `foo` takes an argument, but passing arguments to jobs is not a requirement. It depends on how you've implemented your worker function.
|
||||
|
||||
|
@ -19,7 +19,7 @@ Wasp's Express server has the following middleware by default:
|
||||
- [express.json](https://expressjs.com/en/api.html#express.json) (which uses [body-parser](https://github.com/expressjs/body-parser#bodyparserjsonoptions)): parses incoming request bodies in a middleware before your handlers, making the result available under the `req.body` property.
|
||||
|
||||
:::note
|
||||
JSON middlware is required for [Operations](../data-model/operations/overview) to function properly.
|
||||
JSON middleware is required for [Operations](../data-model/operations/overview) to function properly.
|
||||
:::
|
||||
- [express.urlencoded](https://expressjs.com/en/api.html#express.urlencoded) (which uses [body-parser](https://expressjs.com/en/resources/middleware/body-parser.html#bodyparserurlencodedoptions)): returns middleware that only parses urlencoded bodies and only looks at requests where the `Content-Type` header matches the type option.
|
||||
- [cookieParser](https://github.com/expressjs/cookie-parser#readme): parses Cookie header and populates `req.cookies` with an object keyed by the cookie names.
|
||||
|
@ -52,7 +52,7 @@ rm -r migrations/
|
||||
wasp clean
|
||||
```
|
||||
|
||||
3. Ensure your new database is running (check the [section on connecing to a database](#connecting-to-a-database) to see how). Leave it running, since we need it for the next step.
|
||||
3. Ensure your new database is running (check the [section on connecting to a database](#connecting-to-a-database) to see how). Leave it running, since we need it for the next step.
|
||||
4. In a different terminal, run `wasp db migrate-dev` to apply the changes and create a new initial migration.
|
||||
5. That is it, you are all done!
|
||||
|
||||
|
@ -577,7 +577,7 @@ Since both arguments are positional, you can name the parameters however you wan
|
||||
|
||||
<ShowForTs>
|
||||
|
||||
Afer you [declare the Action](#declaring-actions), Wasp generates a generic type you can use when defining its implementation.
|
||||
After you [declare the Action](#declaring-actions), Wasp generates a generic type you can use when defining its implementation.
|
||||
For the Action declared as `createSomething`, the generated type is called `CreateSomething`:
|
||||
|
||||
```ts
|
||||
|
@ -548,7 +548,7 @@ Since both arguments are positional, you can name the parameters however you wan
|
||||
|
||||
<ShowForTs>
|
||||
|
||||
Afer you [declare the query](#declaring-queries), Wasp generates a generic type you can use when defining its implementation.
|
||||
After you [declare the query](#declaring-queries), Wasp generates a generic type you can use when defining its implementation.
|
||||
For the Query declared as `getSomething`, the generated type is called `GetSomething`:
|
||||
|
||||
```ts
|
||||
|
@ -48,7 +48,7 @@ All the other types in Wasp language (primitive types (`string`, `number`), comp
|
||||
|
||||
Wasp's type system can be divided into two main categories of types: **fundamental types** and **domain types**.
|
||||
|
||||
While fundamental types are here to be basic building blocks of a a language, and are very similar to what you would see in other popular languages, domain types are what makes Wasp special, as they model the concepts of a web app like `page`, `route` and similar.
|
||||
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 languages, domain types are what make 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/main/waspc/src/Wasp/Analyzer/Type.hs))
|
||||
- Primitive types
|
||||
|
@ -59,7 +59,7 @@ wasp new <project-name> -t saas
|
||||
|
||||
A template for generating embeddings and performing vector similarity search on your text data!
|
||||
|
||||
**Features:** Embeddings & vector similarity search, OpenAI Embeddings API, Vector DB (Pinecone), Tailwind, Fullstack Type Safety
|
||||
**Features:** Embeddings & vector similarity search, OpenAI Embeddings API, Vector DB (Pinecone), Tailwind, Full-stack Type Safety
|
||||
|
||||
Use this template:
|
||||
|
||||
@ -69,9 +69,9 @@ wasp new <project-name> -t embeddings
|
||||
|
||||
### Todo App w/ Typescript
|
||||
|
||||
A simple Todo App with Typescript and Fullstack Type Safety.
|
||||
A simple Todo App with Typescript and Full-stack Type Safety.
|
||||
|
||||
**Features:** Auth (username/password), Fullstack Type Safety
|
||||
**Features:** Auth (username/password), Full-stack Type Safety
|
||||
|
||||
Use this template:
|
||||
|
||||
@ -86,4 +86,4 @@ project description. It will automatically generate your data model, auth, queri
|
||||
|
||||
_You will need to provide your own OpenAI API key to be able to use this template._
|
||||
|
||||
**Features:** Generated using OpenAI's GPT models, Auth (username/password), Queries, Actions, Pages, Fullstack Type Safety
|
||||
**Features:** Generated using OpenAI's GPT models, Auth (username/password), Queries, Actions, Pages, Full-stack Type Safety
|
@ -40,7 +40,7 @@ Within test files, you can import your other source files as usual. For example,
|
||||
|
||||
Running `wasp test client` will start Vitest in watch mode and recompile your Wasp project when changes are made.
|
||||
|
||||
- If you want to see a realtime UI, pass `--ui` as an option.
|
||||
- If you want to see a real-time UI, pass `--ui` as an option.
|
||||
- To run the tests just once, use `wasp test client run`.
|
||||
|
||||
All arguments after `wasp test client` are passed directly to the Vitest CLI, so check out [their documentation](https://vitest.dev/guide/cli.html) for all of the options.
|
||||
|
@ -35,7 +35,7 @@ Once you provide an app title, app description, and choose some basic settings,
|
||||
|
||||
If you want to know more, check this [blog post](/blog/2023/07/10/gpt-web-app-generator) for more details on how Mage works, or this [blog post](blog/2023/07/17/how-we-built-gpt-web-app-generator) for a high-level overview of how we implemented it.
|
||||
|
||||
## Wasp Cli
|
||||
## Wasp CLI
|
||||
|
||||
You can create a new Wasp app using Wasp AI by running `wasp new` in your terminal and picking AI generation.
|
||||
|
||||
|
@ -135,7 +135,7 @@ This might seem redundant, but it makes our examples future-proof and helps reas
|
||||
- **What you're trying to do.**
|
||||
- **What your fears are.**
|
||||
- **Which balances you're trying to strike.**
|
||||
- **Do your best to come up with a good and straighforward way to say something.** Again, this will help the reviewer focus on high-level issues instead of rephrasing your sentences.
|
||||
- **Do your best to come up with a good and straightforward way to say something.** Again, this will help the reviewer focus on high-level issues instead of rephrasing your sentences.
|
||||
- **Read and correct your text several times before submitting it (preferably with some time between the readings).** This is similar to proofreading but has more to do with content and communication style than grammar.
|
||||
A time offset is beneficial because it removes the text from your short-term memory, helping you view it more objectively.
|
||||
- **It's OK to ask AI to improve your text.** Just make sure to check it and correct it. You should always sign off on the last version.
|
||||
|
@ -238,7 +238,7 @@ If you are deploying an app that requires any other environment variables (like
|
||||
wasp deploy fly cmd secrets set GOOGLE_CLIENT_ID=<...> GOOGLE_CLIENT_SECRET=<...> --context=server
|
||||
```
|
||||
|
||||
### Mutliple Fly Organizations
|
||||
### Multiple Fly Organizations
|
||||
|
||||
If you have multiple organizations, you can specify a `--org` option. For example:
|
||||
|
||||
|
@ -64,7 +64,7 @@ Here are the environment variables your server will be looking for:
|
||||
|
||||
- `DATABASE_URL` <Required />
|
||||
|
||||
The URL of the Postgres database you want your app to use (e.g., `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`).
|
||||
The URL of the PostgreSQL database you want your app to use (e.g., `postgresql://mydbuser:mypass@localhost:5432/nameofmydb`).
|
||||
|
||||
- `WASP_WEB_CLIENT_URL` <Required />
|
||||
|
||||
@ -154,7 +154,7 @@ flyctl launch --remote-only
|
||||
|
||||
This will ask you a series of questions, such as asking you to choose a region and whether you'd like a database.
|
||||
|
||||
- Say **yes** to **Would you like to set up a Postgresql database now?** and select **Development**. Fly.io will set a `DATABASE_URL` for you.
|
||||
- Say **yes** to **Would you like to set up a PostgreSQL database now?** and select **Development**. Fly.io will set a `DATABASE_URL` for you.
|
||||
- Say **no** to **Would you like to deploy now?** (and to any additional questions).
|
||||
|
||||
We still need to set up several environment variables.
|
||||
@ -330,8 +330,8 @@ Let's deploy our server first:
|
||||
Open the `Settings` and go to the `Variables` tab:
|
||||
|
||||
- click **Variable reference** and select `DATABASE_URL` (it will populate it with the correct value)
|
||||
- add `WASP_WEB_CLIENT_URL` - enter the the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
|
||||
- add `WASP_SERVER_URL` - enter the the `server` domain (e.g. `https://server-production-XXXX.up.railway.app`)
|
||||
- add `WASP_WEB_CLIENT_URL` - enter the `client` domain (e.g. `https://client-production-XXXX.up.railway.app`)
|
||||
- add `WASP_SERVER_URL` - enter the `server` domain (e.g. `https://server-production-XXXX.up.railway.app`)
|
||||
- add `JWT_SECRET` - enter a random string at least 32 characters long (use an [online generator](https://djecrety.ir/))
|
||||
|
||||
<AddExternalAuthEnvVarsReminder />
|
||||
@ -461,7 +461,7 @@ railway up
|
||||
|
||||
And now your Wasp should be deployed! 🐝 🚂 🚀
|
||||
|
||||
Back in your [Railway dashboard](https://railway.app/dashboard), click on your project and you should see your newly deployed services: Postgres, Server, and Client.
|
||||
Back in your [Railway dashboard](https://railway.app/dashboard), click on your project and you should see your newly deployed services: PostgreSQL, Server, and Client.
|
||||
|
||||
### Updates & Redeploying
|
||||
|
||||
@ -497,7 +497,7 @@ Unless you want to deploy to an existing Heroku app, let's create a new Heroku a
|
||||
heroku create <app-name>
|
||||
```
|
||||
|
||||
Unless you have an external Postgres database that you want to use, let's create a new database on Heroku and attach it to our app:
|
||||
Unless you have an external PostgreSQL database that you want to use, let's create a new database on Heroku and attach it to our app:
|
||||
|
||||
```
|
||||
heroku addons:create --app <app-name> heroku-postgresql:mini
|
||||
|
@ -127,7 +127,7 @@ Let's write an example Job that will print a message to the console and return a
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
And that'is it. Your job will be executed by `PgBoss` as if you called `foo({ name: "Johnny" })`.
|
||||
And that's it. Your job will be executed by `PgBoss` as if you called `foo({ name: "Johnny" })`.
|
||||
|
||||
In our example, `foo` takes an argument, but passing arguments to jobs is not a requirement. It depends on how you've implemented your worker function.
|
||||
|
||||
|
@ -19,7 +19,7 @@ Wasp's Express server has the following middleware by default:
|
||||
- [express.json](https://expressjs.com/en/api.html#express.json) (which uses [body-parser](https://github.com/expressjs/body-parser#bodyparserjsonoptions)): parses incoming request bodies in a middleware before your handlers, making the result available under the `req.body` property.
|
||||
|
||||
:::note
|
||||
JSON middlware is required for [Operations](../data-model/operations/overview) to function properly.
|
||||
JSON middleware is required for [Operations](../data-model/operations/overview) to function properly.
|
||||
:::
|
||||
- [express.urlencoded](https://expressjs.com/en/api.html#express.urlencoded) (which uses [body-parser](https://expressjs.com/en/resources/middleware/body-parser.html#bodyparserurlencodedoptions)): returns middleware that only parses urlencoded bodies and only looks at requests where the `Content-Type` header matches the type option.
|
||||
- [cookieParser](https://github.com/expressjs/cookie-parser#readme): parses Cookie header and populates `req.cookies` with an object keyed by the cookie names.
|
||||
|
@ -52,7 +52,7 @@ rm -r migrations/
|
||||
wasp clean
|
||||
```
|
||||
|
||||
3. Ensure your new database is running (check the [section on connecing to a database](#connecting-to-a-database) to see how). Leave it running, since we need it for the next step.
|
||||
3. Ensure your new database is running (check the [section on connecting to a database](#connecting-to-a-database) to see how). Leave it running, since we need it for the next step.
|
||||
4. In a different terminal, run `wasp db migrate-dev` to apply the changes and create a new initial migration.
|
||||
5. That is it, you are all done!
|
||||
|
||||
|
@ -577,7 +577,7 @@ Since both arguments are positional, you can name the parameters however you wan
|
||||
|
||||
<ShowForTs>
|
||||
|
||||
Afer you [declare the Action](#declaring-actions), Wasp generates a generic type you can use when defining its implementation.
|
||||
After you [declare the Action](#declaring-actions), Wasp generates a generic type you can use when defining its implementation.
|
||||
For the Action declared as `createSomething`, the generated type is called `CreateSomething`:
|
||||
|
||||
```ts
|
||||
|
@ -548,7 +548,7 @@ Since both arguments are positional, you can name the parameters however you wan
|
||||
|
||||
<ShowForTs>
|
||||
|
||||
Afer you [declare the query](#declaring-queries), Wasp generates a generic type you can use when defining its implementation.
|
||||
After you [declare the query](#declaring-queries), Wasp generates a generic type you can use when defining its implementation.
|
||||
For the Query declared as `getSomething`, the generated type is called `GetSomething`:
|
||||
|
||||
```ts
|
||||
|
@ -48,7 +48,7 @@ All the other types in Wasp language (primitive types (`string`, `number`), comp
|
||||
|
||||
Wasp's type system can be divided into two main categories of types: **fundamental types** and **domain types**.
|
||||
|
||||
While fundamental types are here to be basic building blocks of a a language, and are very similar to what you would see in other popular languages, domain types are what makes Wasp special, as they model the concepts of a web app like `page`, `route` and similar.
|
||||
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 languages, domain types are what make 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/main/waspc/src/Wasp/Analyzer/Type.hs))
|
||||
- Primitive types
|
||||
|
@ -59,7 +59,7 @@ wasp new <project-name> -t saas
|
||||
|
||||
A template for generating embeddings and performing vector similarity search on your text data!
|
||||
|
||||
**Features:** Embeddings & vector similarity search, OpenAI Embeddings API, Vector DB (Pinecone), Tailwind, Fullstack Type Safety
|
||||
**Features:** Embeddings & vector similarity search, OpenAI Embeddings API, Vector DB (Pinecone), Tailwind, Full-stack Type Safety
|
||||
|
||||
Use this template:
|
||||
|
||||
@ -69,9 +69,9 @@ wasp new <project-name> -t embeddings
|
||||
|
||||
### Todo App w/ Typescript
|
||||
|
||||
A simple Todo App with Typescript and Fullstack Type Safety.
|
||||
A simple Todo App with Typescript and Full-stack Type Safety.
|
||||
|
||||
**Features:** Auth (username/password), Fullstack Type Safety
|
||||
**Features:** Auth (username/password), Full-stack Type Safety
|
||||
|
||||
Use this template:
|
||||
|
||||
@ -86,4 +86,4 @@ project description. It will automatically generate your data model, auth, queri
|
||||
|
||||
_You will need to provide your own OpenAI API key to be able to use this template._
|
||||
|
||||
**Features:** Generated using OpenAI's GPT models, Auth (username/password), Queries, Actions, Pages, Fullstack Type Safety
|
||||
**Features:** Generated using OpenAI's GPT models, Auth (username/password), Queries, Actions, Pages, Full-stack Type Safety
|
@ -40,7 +40,7 @@ Within test files, you can import your other source files as usual. For example,
|
||||
|
||||
Running `wasp test client` will start Vitest in watch mode and recompile your Wasp project when changes are made.
|
||||
|
||||
- If you want to see a realtime UI, pass `--ui` as an option.
|
||||
- If you want to see a real-time UI, pass `--ui` as an option.
|
||||
- To run the tests just once, use `wasp test client run`.
|
||||
|
||||
All arguments after `wasp test client` are passed directly to the Vitest CLI, so check out [their documentation](https://vitest.dev/guide/cli.html) for all of the options.
|
||||
|
@ -35,7 +35,7 @@ Once you provide an app title, app description, and choose some basic settings,
|
||||
|
||||
If you want to know more, check this [blog post](/blog/2023/07/10/gpt-web-app-generator) for more details on how Mage works, or this [blog post](blog/2023/07/17/how-we-built-gpt-web-app-generator) for a high-level overview of how we implemented it.
|
||||
|
||||
## Wasp Cli
|
||||
## Wasp CLI
|
||||
|
||||
You can create a new Wasp app using Wasp AI by running `wasp new` in your terminal and picking AI generation.
|
||||
|
||||
|
@ -135,7 +135,7 @@ This might seem redundant, but it makes our examples future-proof and helps reas
|
||||
- **What you're trying to do.**
|
||||
- **What your fears are.**
|
||||
- **Which balances you're trying to strike.**
|
||||
- **Do your best to come up with a good and straighforward way to say something.** Again, this will help the reviewer focus on high-level issues instead of rephrasing your sentences.
|
||||
- **Do your best to come up with a good and straightforward way to say something.** Again, this will help the reviewer focus on high-level issues instead of rephrasing your sentences.
|
||||
- **Read and correct your text several times before submitting it (preferably with some time between the readings).** This is similar to proofreading but has more to do with content and communication style than grammar.
|
||||
A time offset is beneficial because it removes the text from your short-term memory, helping you view it more objectively.
|
||||
- **It's OK to ask AI to improve your text.** Just make sure to check it and correct it. You should always sign off on the last version.
|
||||
|
Loading…
Reference in New Issue
Block a user