![\"Medusa\"](\"https://user-images.githubusercontent.com/7554214/153162406-bf8fd16f-aa98-4604-b87b-e13ab4baf604.png\")
\n \n\n\nAn open source composable commerce engine built for developers.\n
\n\n\n## Getting started\n\nInstall the package:\n\n```bash\nyarn add @medusajs/admin\n```\n\nAdd the plugin to your `medusa-config.js`:\n\n```js\nmodule.exports = {\n // ...\n plugins: [\n {\n resolve: \"@medusajs/admin\",\n options: {\n // ...\n },\n },\n ],\n // ...\n}\n```\n\n## Configuration\n\nThe plugin can be configured with the following options:\n\n| Option | Type | Description | Default |\n| ------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| `serve` | `boolean?` | Whether to serve the admin dashboard or not. | `true` |\n| `path` | `string?` | The path the admin server should run on. Should not be prefixed or suffixed with a slash. Cannot be one of the reserved paths: `\"admin\"` and `\"store\"`. | `\"app\"` |\n| `outDir` | `string?` | Optional path for where to output the admin build files | `undefined` |\n| `autoRebuild` | `boolean?` | Decides whether the admin UI should be rebuild if any changes or a missing build is detected during server startup | `false` |\n\n**Hint**: You can import the PluginOptions type for inline documentation for the different options:\n\n```js\nmodule.exports = {\n // ...\n plugins: [\n {\n resolve: \"@medusajs/admin\",\n /** @type {import('@medusajs/admin').PluginOptions} */\n options: {\n path: \"app\",\n },\n },\n ],\n // ...\n}\n```\n\n## Building the admin dashboard\n\nThe admin will be built automatically the first time you start your server if you have enabled `autoRebuild`. Any subsequent changes to the plugin options will result in a rebuild of the admin dashboard.\n\nYou may need to manually trigger a rebuild sometimes, for example after you have upgraded to a newer version of `@medusajs/admin`, or if you have disabled `autoRebuild`. You can do so by adding the following script to your `package.json`:\n\n```json\n{\n \"scripts\": {\n \"build:admin\": \"medusa-admin build\"\n }\n}\n```\n\n## Accessing the admin dashboard\n\nThe admin dashboard will be available at `your-server-url/app`, unless you have specified a custom path in the plugin options. If you are running your server locally on port 9000 with the default path `\"app\"`, you will be able access the admin dashboard at `http://localhost:9000/app`.\n","readmeFilename":"README.md"}![\"Medusa](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n ![\"Current](\"https://circleci.com/gh/medusajs/medusa.svg?style=shield\")
\n ![\"PRs](\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat\"){kind=icon}
\n ![\"Product](\"https://img.shields.io/badge/Product%20Hunt-%231%20Product%20of%20the%20Day-%23DA552E\"){kind=icon}
![\"Discord](\"https://img.shields.io/badge/chat-on%20discord-7289DA.svg\"){kind=icon}
\n ![\"Follow](\"https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs\")
\n