{"id":18773143,"url":"https://github.com/raideno/medusa-plugin-settings","last_synced_at":"2025-04-13T09:07:35.801Z","repository":{"id":206859282,"uuid":"717544524","full_name":"raideno/medusa-plugin-settings","owner":"raideno","description":"Medusa Plugin Settings is a plugin made for medusa that will make it easier to add new settings with ui to your admin dashboard.","archived":false,"fork":false,"pushed_at":"2023-11-18T12:52:55.000Z","size":47,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T09:07:28.465Z","etag":null,"topics":["medusa","medusa-plugin","medusa-plugin-settings"],"latest_commit_sha":null,"homepage":"https://medusa-plugin-settings.raideno.xyz","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raideno.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-11T19:41:57.000Z","updated_at":"2025-04-04T05:07:30.000Z","dependencies_parsed_at":"2023-11-12T21:21:37.060Z","dependency_job_id":"d2a44cea-8d79-49d9-aa31-be0b67d19a4a","html_url":"https://github.com/raideno/medusa-plugin-settings","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"9f46e4aa3eae014cd56a68ca5625b5ef02fd9348"},"previous_names":["raideno/medusa-plugin-settings"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fmedusa-plugin-settings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fmedusa-plugin-settings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fmedusa-plugin-settings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raideno%2Fmedusa-plugin-settings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raideno","download_url":"https://codeload.github.com/raideno/medusa-plugin-settings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248688567,"owners_count":21145766,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["medusa","medusa-plugin","medusa-plugin-settings"],"created_at":"2024-11-07T19:33:03.850Z","updated_at":"2025-04-13T09:07:35.753Z","avatar_url":"https://github.com/raideno.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Medusa Plugin Settings\n\n![Thumbnail](./assets/plugin-thumbnail.png)\n\nThe Medusa Plugin Settings streamlines the addition of new settings with a user interface to your admin dashboard, enhancing customization and efficiency. Tailored for Medusa, it simplifies the integration process, providing a seamless and user-friendly experience for administrators.\n\n## Documentation\n\nSee [Documentation](https://medusa-plugin-settings.raideno.xyz).\n\n## Contact\n\n**Discord:** @raideno `ID:423897604330618883`\n\n## Usage\n\n### Installation\n\n```bash\nnpm i medusa-plugin-settings\n```\n\n### Run Migrations\n\nFirst build your backend.\n\n```bash\nnpm run build\n```\n\nRun the migrations\n\n```bash\nnpx medusa migrations run\n```\n\n### Configuration\n\nThis env variables are required on the admin: `BACKEND_URL`\n\n```ts\n// medusa-config.js\n\nconst plugins = [\n  /** @type {import('medusa-plugin-settings').PluginOptions} */\n  {\n    resolve: \"medusa-plugin-settings\",\n    options: {\n      enableUI: true,\n      backendUrl: process.env.BACKEND_URL || \"http://localhost:9000\",\n      settings: [\n        {\n          id: \"is-store-working\",\n          name: \"Is Store Enabled\",\n          type: SettingSchemaTypes.BOOLEAN,\n          defaultValue: true,\n          // optional\n          description:\n            \"If set to false store-front will no more be accessible.\",\n          note: \"BE CARFUL!\",\n        },\n        // other settings..\n      ],\n    },\n  },\n];\n\n// ...\n```\n\n### Use Settings\n\nThe plugin will make sure at each startup that every setting is initialized with it's default value / previously set value and make them available through endpoints or via the admin UI under the settings tab.\n\n[Image]().\n\n[Video]().\n\n### Endpoints\n\n- **`GET`** `\u003cBACKEND_URL\u003e/store/extended-settings`\n\n- **`GET`** `\u003cBACKEND_URL\u003e/store/extended-settings/:settingId`\n\n## Documentation\n\nSee [Documentation](https://medusa-plugin-settings.raideno.xyz).\n\n## Examples \u0026 Use Cases\n\n- [Use Case -1](https://medusa-plugin-settings.raideno.xyz)\n- [Use Case -2](https://medusa-plugin-settings.raideno.xyz)\n- [Use Case -3](https://medusa-plugin-settings.raideno.xyz)\n- [Use Case -4](https://medusa-plugin-settings.raideno.xyz)\n\n## Contribution\n\nAnyone is welcome to contribute or suggest new features, please contact me on **Discord:** @raideno `ID:423897604330618883`.\n\n## Features\n\n- **Effortless UI Integration for Settings:** The Medusa Plugin Settings simplifies the incorporation of new settings into your admin dashboard. Mark your settings with a decorator, and watch as the plugin seamlessly creates a user interface within the Medusa dashboard.\n\n- **Streamlined Configuration Operations:** With the added UI, managing your settings becomes a breeze. Perform essential configuration tasks such as creating new settings, editing existing ones, viewing detailed information, and deleting settings with unparalleled ease.\n\n- **Tailor to Your Needs:** Customize the generated UI according to your specific requirements. The Medusa Plugin Settings provides flexibility in controlling the appearance and behavior of UI elements, ensuring a personalized experience.\n\n- **Endpoint Exposure for Enhanced Interaction:** Beyond dashboard integration, this plugin exposes your settings through a dedicated endpoint. This feature facilitates seamless interaction between your store and the configured settings, offering a programmatic avenue for efficient communication.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraideno%2Fmedusa-plugin-settings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraideno%2Fmedusa-plugin-settings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraideno%2Fmedusa-plugin-settings/lists"}