{"_id":"@ajeebsa/admin","_rev":"2-79b73344906f4280cbd6a85a6ff13145","name":"@ajeebsa/admin","dist-tags":{"latest":"6.0.5"},"versions":{"6.0.3":{"name":"@ajeebsa/admin","version":"6.0.3","bin":{"medusa-admin":"bin/medusa-admin.js"},"main":"lib/index.js","types":"lib/index.d.ts","scripts":{"build":"tsc --build","test":"jest --passWithNoTests"},"repository":{"type":"git","url":"git+https://github.com/medusajs/medusa.git","directory":"packages/admin"},"dependencies":{"@ajeebsa/admin-ui":"*","@rollup/plugin-alias":"5.0.0","@rollup/plugin-commonjs":"24.1.0","@rollup/plugin-json":"6.0.0","@rollup/plugin-node-resolve":"15.0.2","@rollup/plugin-replace":"5.0.2","@rollup/plugin-virtual":"^3.0.1","commander":"^10.0.0","dotenv":"16.0.3","esbuild":"0.17.18","express":"4.18.2","fs-extra":"11.1.0","lodash":"^4.17.21","medusa-core-utils":"1.2.0","rollup":"3.20.7","rollup-plugin-esbuild":"5.0.0","ts-dedent":"^2.2.0"},"peerDependencies":{"@medusajs/medusa":"1.12.0"},"devDependencies":{"@medusajs/medusa":"*","@types/express":"^4.17.13","typescript":"^4.9.3"},"packageManager":"yarn@3.2.1","_id":"@ajeebsa/admin@6.0.3","gitHead":"eecb20bcf80a4df9aef0936c1e862b2aa167f53e","description":"

\"Medusa\"

@medusajs/admin \"Medusa\"

@medusajs/admin \"Medusa\"

@medusajs/admin \"Medusa\"

@medusajs/admin \n \n \"Medusa\"\n \n

\n

\n @medusajs/admin\n

\n\n

\n Documentation |\n Medusa Admin Demo |\n Website\n

\n\n

\nAn open source composable commerce engine built for developers.\n

\n

\n \n \"Medusa\n \n \n \"Current\n \n \n \"PRs\n \n \"Product\n \n \"Discord\n \n \n \"Follow\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"}