Files
medusa-store/packages/create-medusa-app
Shahed Nasser 30ce35b163 feat(create-medusa-app): add database options (#4733)
## What

Adds new options for easier usage of the `create-medusa-app` command for regular medusa users.

The following options are added:

- `--skip-db`: Skips creating the database, running migrations, and seeding, and subsequently skips opening the browser. Useful if the developer wants to set the database URL at a later point in the configurations.
- `--db-url <url>`:  Skips database creation and sets the database URL to the provided URL. Throws an error if can't connect to the database. Will still run migrations and open the admin after project creation. Useful if the developer already has database created, locally or remotely.
- `--no-migrations`: Skips running migrations, creating admin user, and seeding. If used, it's expected that you pass the `--db-url` option with a url of a database that has all necessary migrations. Otherwise, unexpected errors will occur. Helpful only if combined with `--db-url`
- `--no-browser`: Disables opening the browser at the end of the project creation and only shows success message.
- `--directory-path <path>`: Allows specifying the directory path to install the project in. Useful for testing.
2023-08-15 08:08:54 +00:00
..
2023-07-27 13:19:14 +02:00

Medusa

create-medusa-app

Documentation | Website

An open source composable commerce engine built for developers.

Medusa is released under the MIT license. Current CircleCI build status. PRs welcome! Product Hunt Discord Chat Follow @medusajs

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:

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