81fea66ef3
* docs: added documentation for local file service * fixed eslint errors * change local file service package name
108 lines
2.6 KiB
Plaintext
108 lines
2.6 KiB
Plaintext
---
|
|
description: 'This quickstart guide will help you set up a Medusa backend in three steps.'
|
|
addHowToData: true
|
|
---
|
|
|
|
import Feedback from '@site/src/components/Feedback';
|
|
import DocCardList from '@theme/DocCardList';
|
|
import Icons from '@theme/Icon';
|
|
|
|
# Install Medusa Backend
|
|
|
|
This document will guide you through setting up your Medusa backend in a three steps.
|
|
|
|
## Prerequisites
|
|
|
|
### Node.js
|
|
|
|
Medusa supports Node v16 or greater. You can check which version of Node you have by running the following command:
|
|
|
|
```bash noReport
|
|
node -v
|
|
```
|
|
|
|
You can install Node from the [official website](https://nodejs.org/en/).
|
|
|
|
### Git
|
|
|
|
Git is required for this setup. You can find instructions on how to install it from the [Set up your dev environment documentation](../../development/backend/prepare-environment.mdx#git).
|
|
|
|
---
|
|
|
|
## Create a Medusa Backend
|
|
|
|
:::tip
|
|
|
|
It is recommended to use [Yarn](https://yarnpkg.com/getting-started/install) for the installation process as it's much faster than using NPM.
|
|
|
|
:::
|
|
|
|
### 1. Install Medusa CLI
|
|
|
|
```bash npm2yarn
|
|
npm install @medusajs/medusa-cli -g
|
|
```
|
|
|
|
:::note
|
|
|
|
If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](../../troubleshooting/cli-installation-errors.mdx).
|
|
|
|
:::
|
|
|
|
### 2. Create a new Medusa project
|
|
|
|
```bash noReport
|
|
medusa new my-medusa-store --seed
|
|
```
|
|
|
|
### 3. Start your Medusa backend
|
|
|
|
```bash noReport
|
|
cd my-medusa-store
|
|
medusa develop
|
|
```
|
|
|
|
<Feedback
|
|
event="survey_server_quickstart"
|
|
question="Did you set up the backend successfully?"
|
|
positiveQuestion="Is there anything that should improved?"
|
|
negativeQuestion="Please describe the issue you faced."
|
|
/>
|
|
|
|
### Test the Backend
|
|
|
|
After these three steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line:
|
|
|
|
```bash noReport
|
|
curl localhost:9000/store/products
|
|
```
|
|
|
|
### Health Route
|
|
|
|
You can access `/health` to get health status of your backend.
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
<DocCardList colSize={6} items={[
|
|
{
|
|
type: 'link',
|
|
href: '/development/fundamentals/architecture-overview',
|
|
label: 'Backend Architecture',
|
|
customProps: {
|
|
icon: Icons['circle-stack-solid'],
|
|
description: 'Learn about the different resources that your Medusa backend is made of.'
|
|
}
|
|
},
|
|
{
|
|
type: 'link',
|
|
href: '/development/backend/install',
|
|
label: 'Backend Configurations',
|
|
customProps: {
|
|
icon: Icons['tools-solid'],
|
|
description: 'Learn about configuring your backend and loading environment variables.'
|
|
}
|
|
}
|
|
]} />
|