feat(medusa-file-local): Local file storage plugin (#4118)

Simple local file storage to eliminate/reduce friction related to file services when developers are trying out Medusa for the first time
2023-05-22 09:11:38 +00:00
parent 1709c0cc69
commit c4aae6b976
8 changed files with 578 additions and 7 deletions
@@ -0,0 +1,49 @@
+# Local file storage
+
+Store uploaded files to your Medusa backend locally.
+
+> Not suited for production environments
+
+[Plugin Documentation](https://docs.medusajs.com/plugins/file-service/local) | [Medusa Website](https://medusajs.com) | [Medusa Repository](https://github.com/medusajs/medusa)
+
+## Features
+
+- Store product images locally
+
+---
+
+## Prerequisites
+
+- [Medusa backend](https://docs.medusajs.com/development/backend/install)
+
+---
+
+## How to Install
+
+1\. Run the following command in the directory of the Medusa backend:
+
+```bash
+npm install medusa-file-local
+```
+
+2 \. In `medusa-config.js` add the following at the end of the `plugins` array:
+
+```js
+const plugins = [
+  // ...
+  `medusa-file-local`
+]
+```
+
+---
+
+## Test the Plugin
+
+1\. Run the following command in the directory of the Medusa backend to run the backend:
+
+```bash
+npm run start
+```
+
+2\. Upload an image for a product using the admin dashboard or using [the Admin APIs](https://docs.medusajs.com/api/admin#tag/Upload).
+