docs: general fixes across documentation (#4248)
* docs: added details about the migration revert command * added a note about running postgres before the backend * added a link to typeorm's documentation * fix broken links * fixed section title * fixed admonitions
This commit is contained in:
1 parent
af2dc4f75a
commit
2637b82933
8 files changed
+45
-13
No files matched your search
@@ -13,7 +13,11 @@ This document will guide you through setting up your Medusa backend in a three s
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
Medusa requires Node.js v16+, Git, and PostgreSQL to be installed. If you don't have them installed already, you can check out the [Prepare Environment](./prepare-environment.mdx) documnetation to learn how to install them.
|
Before you can install and use Medusa, you need the following tools installed on your machine:
|
||||||
|
|
||||||
|
- [Node.js v16+](./prepare-environment.mdx#nodejs)
|
||||||
|
- [Git](./prepare-environment.mdx#git)
|
||||||
|
- [PostgreSQL](./prepare-environment.mdx#postgresql)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -53,6 +57,12 @@ If you run into any errors while installing the CLI tool, check out the [trouble
|
|||||||
|
|
||||||
### 3. Start your Medusa backend
|
### 3. Start your Medusa backend
|
||||||
|
|
||||||
|
:::note
|
||||||
|
|
||||||
|
Make sure your PostgreSQL server is running before you run the Medusa backend.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
```bash noReport
|
```bash noReport
|
||||||
cd my-medusa-store
|
cd my-medusa-store
|
||||||
medusa develop
|
medusa develop
|
||||||
|
|||||||
@@ -177,6 +177,12 @@ await postRepository.softDelete(post.id)
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Advanced Entity Definitions
|
||||||
|
|
||||||
|
With entities, you can create relationships, index keys, and more. As Medusa uses Typeorm, you can learn about using these functionalities through [Typeorm's documentation](https://typeorm.io/).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
- [Extend Entity](./extend-entity.md)
|
- [Extend Entity](./extend-entity.md)
|
||||||
|
|||||||
@@ -202,3 +202,9 @@ You can also add custom relations by changing the following defined variables:
|
|||||||
- `defaultStoreProductsRelations`: The relations of a product that are retrieved and returned by default in the product's store endpoints.
|
- `defaultStoreProductsRelations`: The relations of a product that are retrieved and returned by default in the product's store endpoints.
|
||||||
|
|
||||||
If you want to apply this example for a different entity or set of endpoints, you would need to change the import path `@medusajs/medusa/dist/api/routes/store/products/index` to the path of the endpoints you're targeting. You also need to change `allowedStoreProductsFields` and `defaultStoreProductsFields` to the names of the variables in that file, and the same goes for relations. Typically, these names would be of the format `(allowed|default)(Store|Admin)(Entity)(Fields|Relation)`.
|
If you want to apply this example for a different entity or set of endpoints, you would need to change the import path `@medusajs/medusa/dist/api/routes/store/products/index` to the path of the endpoints you're targeting. You also need to change `allowedStoreProductsFields` and `defaultStoreProductsFields` to the names of the variables in that file, and the same goes for relations. Typically, these names would be of the format `(allowed|default)(Store|Admin)(Entity)(Fields|Relation)`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Advanced Entity Definitions
|
||||||
|
|
||||||
|
With entities, you can create relationships, index keys, and more. As Medusa uses Typeorm, you can learn about using these functionalities through [Typeorm's documentation](https://typeorm.io/).
|
||||||
@@ -90,7 +90,7 @@ npm run build
|
|||||||
The last step is to run the migration with the command detailed earlier
|
The last step is to run the migration with the command detailed earlier
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa migrations run
|
npx @medusajs/medusa-cli migrations run
|
||||||
```
|
```
|
||||||
|
|
||||||
If you check your database now you should see that the change defined by the migration has been applied successfully.
|
If you check your database now you should see that the change defined by the migration has been applied successfully.
|
||||||
|
|||||||
@@ -25,16 +25,14 @@ Migrations are used to apply changes to the database schema. However, there are
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## How to Run Migrations
|
## Migration Commands
|
||||||
|
|
||||||
Migrations in Medusa can be done in one of two ways:
|
|
||||||
|
|
||||||
### Migrate Command
|
### Migrate Command
|
||||||
|
|
||||||
Using the Medusa CLI tool, you can run migrations with the following command:
|
Using the Medusa CLI tool, you can run migrations with the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa migrations run
|
npx @medusajs/medusa-cli migrations run
|
||||||
```
|
```
|
||||||
|
|
||||||
This will check for any migrations that contain changes to your database schema that aren't applied yet and run them on your backend.
|
This will check for any migrations that contain changes to your database schema that aren't applied yet and run them on your backend.
|
||||||
@@ -46,10 +44,22 @@ Seeding is the process of filling your database with data that is either essenti
|
|||||||
You can use the following command to seed your database:
|
You can use the following command to seed your database:
|
||||||
|
|
||||||
```bash npm2yarn
|
```bash npm2yarn
|
||||||
npm run seed
|
npx @medusajs/medusa-cli@latest seed -f ./data/seed.json
|
||||||
```
|
```
|
||||||
|
|
||||||
This will use the underlying `seed` command provided by Medusa's CLI to seed your database with data from the file `data/seed.json` on your Medusa backend.
|
This assumes that you have the file `data/seed.json` in your Medusa backend, which is available by default. It includes the demo data to seed into your database.
|
||||||
|
|
||||||
|
### Revert Migrations
|
||||||
|
|
||||||
|
To revert the last migration you ran, run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx @medusajs/medusa-cli@latest migrations revert
|
||||||
|
```
|
||||||
|
|
||||||
|
### Other Migrations Commands
|
||||||
|
|
||||||
|
You can learn about migration commands available in the Medusa CLI tool by referring to the [Medusa CLI reference](../../../cli/reference.md#migrations)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ If you run into any errors while installing the CLI tool, check out the [trouble
|
|||||||
The recommended way to create a plugin is using the Medusa CLI. Run the following command to create a new Medusa project:
|
The recommended way to create a plugin is using the Medusa CLI. Run the following command to create a new Medusa project:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa new medusa-plugin-custom
|
npx @medusajs/medusa-cli@latest new medusa-plugin-custom
|
||||||
```
|
```
|
||||||
|
|
||||||
Where `medusa-plugin-custom` is the name of the plugin you’re creating. In Medusa, plugins are named based on their functionalities.
|
Where `medusa-plugin-custom` is the name of the plugin you’re creating. In Medusa, plugins are named based on their functionalities.
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ Instead of using the default Medusa backend starter, you must use the [Contentfu
|
|||||||
In your terminal, run the following command to install the backend:
|
In your terminal, run the following command to install the backend:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa new medusa-contentful https://github.com/medusajs/medusa-starter-contentful
|
npx @medusajs/medusa-cli@latest new medusa-contentful https://github.com/medusajs/medusa-starter-contentful
|
||||||
```
|
```
|
||||||
|
|
||||||
This installs a new Medusa backend in the directory `medusa-contentful`.
|
This installs a new Medusa backend in the directory `medusa-contentful`.
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ You can use the Strapi plugin on an existing Medusa backend, however, existing d
|
|||||||
To create your Medusa backend, run the following command:
|
To create your Medusa backend, run the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa new medusa-backend
|
npx @medusajs/medusa-cli@latest new medusa-backend
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configure your Backend
|
### Configure your Backend
|
||||||
@@ -107,13 +107,13 @@ You must then configure your backend to:
|
|||||||
After configuring the connection to the database, you must run migrations to add the necessary database schema definitions in your database. To do that, run the following command in the `medusa-backend` directory:
|
After configuring the connection to the database, you must run migrations to add the necessary database schema definitions in your database. To do that, run the following command in the `medusa-backend` directory:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa migrations run
|
npx @medusajs/medusa-cli@latest migrations run
|
||||||
```
|
```
|
||||||
|
|
||||||
You can optionally seed your database with demo data by running the `seed` command:
|
You can optionally seed your database with demo data by running the `seed` command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
medusa seed --seed-file=data/seed.json
|
npx @medusajs/medusa-cli@latest seed --seed-file=data/seed.json
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
Reference in new issue
Block a user