59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
<p align="center">
|
|
<a href="https://www.medusajs.com">
|
|
<img alt="Medusa" src="https://user-images.githubusercontent.com/7554214/153162406-bf8fd16f-aa98-4604-b87b-e13ab4baf604.png" width="100" />
|
|
</a>
|
|
</p>
|
|
<h1 align="center">
|
|
create-medusa-app
|
|
</h1>
|
|
|
|
<h4 align="center">
|
|
<a href="https://docs.medusajs.com">Documentation</a> |
|
|
<a href="https://www.medusajs.com">Website</a>
|
|
</h4>
|
|
|
|
<p align="center">
|
|
An open source composable commerce engine built for developers.
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
|
|
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Medusa is released under the MIT license." />
|
|
</a>
|
|
<a href="https://circleci.com/gh/medusajs/medusa">
|
|
<img src="https://circleci.com/gh/medusajs/medusa.svg?style=shield" alt="Current CircleCI build status." />
|
|
</a>
|
|
<a href="https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md">
|
|
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
|
|
</a>
|
|
<a href="https://www.producthunt.com/posts/medusa"><img src="https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E" alt="Product Hunt"></a>
|
|
<a href="https://discord.gg/xpCwq3Kfn8">
|
|
<img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
|
|
</a>
|
|
<a href="https://twitter.com/intent/follow?screen_name=medusajs">
|
|
<img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
|
|
</a>
|
|
</p>
|
|
|
|
## Overview
|
|
|
|
Using this NPX command, you can setup a Medusa backend and admin along with a PostgreSQL database in simple steps.
|
|
|
|
---
|
|
|
|
## Usage
|
|
|
|
Run the following command in your terminal:
|
|
|
|
```bash
|
|
npx create-medusa-app@latest
|
|
```
|
|
|
|
Then, answer the prompted questions to setup your PostgreSQL database and Medusa project. Once the setup is done, the Medusa admin dashboard will open in your default browser.
|
|
|
|
### Options
|
|
|
|
| Option | Description | Default value |
|
|
|--------------------|-------------------------------------------------------|------------------------------------------------------|
|
|
| `--repo-url <url>` | Create Medusa project from a different repository URL | `https://github.com/medusajs/medusa-starter-default` |
|
|
| `--seed` | Using this option seeds the database with demo data | false |
|