Skip to content

Commit

Permalink
update readme files.
Browse files Browse the repository at this point in the history
  • Loading branch information
@anamarijapapic
anamarijapapic committed Nov 22, 2023
1 parent 86f8536 commit 15bbe23
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 62 deletions.
39 changes: 23 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
<a href="./LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue" alt="MedusaWP is released under the MIT license." />
</a>
<a href="https://github.com/Agilo/medusawp?tab=readme-ov-file#contributing">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>
<p align="center">
<a href="https://nodejs.org/" target="_blank">
<img src="https://img.shields.io/badge/Node.js-%5E20-brightgreen" alt="Node.js ^20">
</a>
Expand All @@ -24,9 +32,6 @@
<a href="https://getcomposer.org/doc/01-basic-usage.md" target="_blank">
<img src="https://img.shields.io/badge/Composer-%5E1-orange" alt="Composer ^1">
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>

MedusaWP is a powerful tool that seamlessly integrates your Medusa e-commerce store with WordPress, offering a range of features to simplify your e-commerce management. We also provide a rich set of Medusa-oriented functions for you to utilize within your WordPress theme.
Expand Down Expand Up @@ -151,12 +156,12 @@ npm run start

3. Connect your Medusa e-commerce store and your WordPress instance. On the default MedusaWP plugin screen enter your Medusa shop URL and credentials - email and password and press "Connect" button.

> **Note**
> [!NOTE]
> If necessary, you can always disconnect from your Medusa shop by opening a dropdown in the upper-right corner, pressing the "Disconnect" button, and confirming your decision.
4. When the connection with Medusa is established, sync your Medusa e-commerce data with WordPress by clicking the "Sync" button. You can also choose to import Medusa thumbnails into the WordPress Media Library directly with the data sync (this may slightly slow down your data sync process), or you can import thumbnails separately later using the "Import" button.

> **Note**
> [!NOTE]
> It is possible to remove all your synced Medusa data from your WordPress site at any time using the "Remove" button. We recommend that you backup your data before proceeding with this action.
5. Once the data synchronization is complete, configure the default settings of the MedusaWP plugin to suit your needs. In the dropdown, you can select the default country, which will be used to automatically create a cart in the corresponding region when a customer lands on the site.
Expand Down Expand Up @@ -190,18 +195,20 @@ After you have installed the requirements, you will need to add a host entry for

Follow these step-by-step instructions to run the project locally:

1. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
2. `cd medusawp` - position into the project directory
3. `npm i` - install all dependencies
1. Fulfill everything mentioned in the prerequisites above
2. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
3. `cd medusawp` - position into the project directory
4. `cp .env.example .env` - set up docker-compose environment variables
5. `cp ./dev/medusa/.env.example ./dev/medusa/.env` - set up Medusa environment variables
6. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
7. `npm run build -w wordpress` - build WordPress
8. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
9. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
10. `npm run seed -w medusa` - seed Medusa DB
11. `npm run migrate -w medusa` - run Medusa migrations
12. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher
6. `npm i` - install all dependencies
7. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
8. `npm run build -w wordpress` - build WordPress
9. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
10. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
11. Open a new terminal tab
12. `npm run seed -w medusa` - seed Medusa DB
13. `npm run migrate -w medusa` - run Medusa migrations
14. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher

WordPress is now available at https://medusawp.test and Medusa Admin dashboard at http://localhost:9000/app.

Expand Down Expand Up @@ -265,5 +272,5 @@ This project is licensed under the [MIT License](./LICENSE).

## Credits

MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
Huge thanks to [all contributors](https://github.com/Agilo/medusawp/graphs/contributors).
39 changes: 23 additions & 16 deletions medusa-plugin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
<a href="./LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue" alt="MedusaWP is released under the MIT license." />
</a>
<a href="https://github.com/Agilo/medusawp?tab=readme-ov-file#contributing">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>
<p align="center">
<a href="https://nodejs.org/" target="_blank">
<img src="https://img.shields.io/badge/Node.js-%5E20-brightgreen" alt="Node.js ^20">
</a>
Expand All @@ -24,9 +32,6 @@
<a href="https://getcomposer.org/doc/01-basic-usage.md" target="_blank">
<img src="https://img.shields.io/badge/Composer-%5E1-orange" alt="Composer ^1">
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>

MedusaWP is a powerful tool that seamlessly integrates your Medusa e-commerce store with WordPress, offering a range of features to simplify your e-commerce management. We also provide a rich set of Medusa-oriented functions for you to utilize within your WordPress theme.
Expand Down Expand Up @@ -151,12 +156,12 @@ npm run start

3. Connect your Medusa e-commerce store and your WordPress instance. On the default MedusaWP plugin screen enter your Medusa shop URL and credentials - email and password and press "Connect" button.

> **Note**
> [!NOTE]
> If necessary, you can always disconnect from your Medusa shop by opening a dropdown in the upper-right corner, pressing the "Disconnect" button, and confirming your decision.
4. When the connection with Medusa is established, sync your Medusa e-commerce data with WordPress by clicking the "Sync" button. You can also choose to import Medusa thumbnails into the WordPress Media Library directly with the data sync (this may slightly slow down your data sync process), or you can import thumbnails separately later using the "Import" button.

> **Note**
> [!NOTE]
> It is possible to remove all your synced Medusa data from your WordPress site at any time using the "Remove" button. We recommend that you backup your data before proceeding with this action.
5. Once the data synchronization is complete, configure the default settings of the MedusaWP plugin to suit your needs. In the dropdown, you can select the default country, which will be used to automatically create a cart in the corresponding region when a customer lands on the site.
Expand Down Expand Up @@ -190,18 +195,20 @@ After you have installed the requirements, you will need to add a host entry for

Follow these step-by-step instructions to run the project locally:

1. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
2. `cd medusawp` - position into the project directory
3. `npm i` - install all dependencies
1. Fulfill everything mentioned in the prerequisites above
2. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
3. `cd medusawp` - position into the project directory
4. `cp .env.example .env` - set up docker-compose environment variables
5. `cp ./dev/medusa/.env.example ./dev/medusa/.env` - set up Medusa environment variables
6. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
7. `npm run build -w wordpress` - build WordPress
8. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
9. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
10. `npm run seed -w medusa` - seed Medusa DB
11. `npm run migrate -w medusa` - run Medusa migrations
12. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher
6. `npm i` - install all dependencies
7. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
8. `npm run build -w wordpress` - build WordPress
9. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
10. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
11. Open a new terminal tab
12. `npm run seed -w medusa` - seed Medusa DB
13. `npm run migrate -w medusa` - run Medusa migrations
14. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher

WordPress is now available at https://medusawp.test and Medusa Admin dashboard at http://localhost:9000/app.

Expand Down Expand Up @@ -265,5 +272,5 @@ This project is licensed under the [MIT License](./LICENSE).

## Credits

MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
Huge thanks to [all contributors](https://github.com/Agilo/medusawp/graphs/contributors).
39 changes: 23 additions & 16 deletions wordpress-plugin/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@
<a href="./LICENSE">
<img src="https://img.shields.io/badge/license-MIT-blue" alt="MedusaWP is released under the MIT license." />
</a>
<a href="https://github.com/Agilo/medusawp?tab=readme-ov-file#contributing">
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>
<p align="center">
<a href="https://nodejs.org/" target="_blank">
<img src="https://img.shields.io/badge/Node.js-%5E20-brightgreen" alt="Node.js ^20">
</a>
Expand All @@ -24,9 +32,6 @@
<a href="https://getcomposer.org/doc/01-basic-usage.md" target="_blank">
<img src="https://img.shields.io/badge/Composer-%5E1-orange" alt="Composer ^1">
</a>
<a href="https://twitter.com/intent/follow?screen_name=Agilo">
<img src="https://img.shields.io/twitter/follow/Agilo" alt="X (formerly Twitter) Follow">
</a>
</p>

MedusaWP is a powerful tool that seamlessly integrates your Medusa e-commerce store with WordPress, offering a range of features to simplify your e-commerce management. We also provide a rich set of Medusa-oriented functions for you to utilize within your WordPress theme.
Expand Down Expand Up @@ -151,12 +156,12 @@ npm run start

3. Connect your Medusa e-commerce store and your WordPress instance. On the default MedusaWP plugin screen enter your Medusa shop URL and credentials - email and password and press "Connect" button.

> **Note**
> [!NOTE]
> If necessary, you can always disconnect from your Medusa shop by opening a dropdown in the upper-right corner, pressing the "Disconnect" button, and confirming your decision.
4. When the connection with Medusa is established, sync your Medusa e-commerce data with WordPress by clicking the "Sync" button. You can also choose to import Medusa thumbnails into the WordPress Media Library directly with the data sync (this may slightly slow down your data sync process), or you can import thumbnails separately later using the "Import" button.

> **Note**
> [!NOTE]
> It is possible to remove all your synced Medusa data from your WordPress site at any time using the "Remove" button. We recommend that you backup your data before proceeding with this action.
5. Once the data synchronization is complete, configure the default settings of the MedusaWP plugin to suit your needs. In the dropdown, you can select the default country, which will be used to automatically create a cart in the corresponding region when a customer lands on the site.
Expand Down Expand Up @@ -190,18 +195,20 @@ After you have installed the requirements, you will need to add a host entry for

Follow these step-by-step instructions to run the project locally:

1. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
2. `cd medusawp` - position into the project directory
3. `npm i` - install all dependencies
1. Fulfill everything mentioned in the prerequisites above
2. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
3. `cd medusawp` - position into the project directory
4. `cp .env.example .env` - set up docker-compose environment variables
5. `cp ./dev/medusa/.env.example ./dev/medusa/.env` - set up Medusa environment variables
6. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
7. `npm run build -w wordpress` - build WordPress
8. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
9. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
10. `npm run seed -w medusa` - seed Medusa DB
11. `npm run migrate -w medusa` - run Medusa migrations
12. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher
6. `npm i` - install all dependencies
7. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
8. `npm run build -w wordpress` - build WordPress
9. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
10. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
11. Open a new terminal tab
12. `npm run seed -w medusa` - seed Medusa DB
13. `npm run migrate -w medusa` - run Medusa migrations
14. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher

WordPress is now available at https://medusawp.test and Medusa Admin dashboard at http://localhost:9000/app.

Expand Down Expand Up @@ -265,5 +272,5 @@ This project is licensed under the [MIT License](./LICENSE).

## Credits

MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
Huge thanks to [all contributors](https://github.com/Agilo/medusawp/graphs/contributors).
30 changes: 16 additions & 14 deletions wordpress-plugin/readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Contributors: Agilo
Donate link: https://agilo.co
Tags: medusa, wordpress, ecommerce, headless, storefront
Requires at least: 5.6
Tested up to: 6.3
Tested up to: 6.4
Requires PHP: 7.4
Stable tag: 1.0.0
License: MIT
Expand Down Expand Up @@ -158,11 +158,11 @@ npm run start
2. After you have logged into your WordPress site, navigate to the MedusaWP plugin settings page, which can be found in the WordPress admin menu.

3. Connect your Medusa e-commerce store and your WordPress instance. On the default MedusaWP plugin screen enter your Medusa shop URL and credentials - email and password and press "Connect" button.
> **Note**
> [!NOTE]
> If necessary, you can always disconnect from your Medusa shop by opening a dropdown in the upper-right corner, pressing the "Disconnect" button, and confirming your decision.

4. When the connection with Medusa is established, sync your Medusa e-commerce data with WordPress by clicking the "Sync" button. You can also choose to import Medusa thumbnails into the WordPress Media Library directly with the data sync (this may slightly slow down your data sync process), or you can import thumbnails separately later using the "Import" button.
> **Note**
> [!NOTE]
> It is possible to remove all your synced Medusa data from your WordPress site at any time using the "Remove" button. We recommend that you backup your data before proceeding with this action.

5. Once the data synchronization is complete, configure the default settings of the MedusaWP plugin to suit your needs. In the dropdown, you can select the default country, which will be used to automatically create a cart in the corresponding region when a customer lands on the site.
Expand Down Expand Up @@ -196,18 +196,20 @@ After you have installed the requirements, you will need to add a host entry for

Follow these step-by-step instructions to run the project locally:

1. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
2. `cd medusawp` - position into the project directory
3. `npm i` - install all dependencies
1. Fulfill everything mentioned in the prerequisites above
2. `git clone https://github.com/Agilo/medusawp.git` - clone the repo
3. `cd medusawp` - position into the project directory
4. `cp .env.example .env` - set up docker-compose environment variables
5. `cp ./dev/medusa/.env.example ./dev/medusa/.env` - set up Medusa environment variables
6. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
7. `npm run build -w wordpress` - build WordPress
8. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
9. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
10. `npm run seed -w medusa` - seed Medusa DB
11. `npm run migrate -w medusa` - run Medusa migrations
12. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher
6. `npm i` - install all dependencies
7. `npm run addcert -w wordpress` - add a self-signed certificate for `medusawp.test`
8. `npm run build -w wordpress` - build WordPress
9. `composer install -d ./wordpress-plugin` - install Composer dependencies for the WordPress plugin
10. `docker-compose --profile wp --profile medusa up` - start WordPress and Medusa Docker containers
11. Open a new terminal tab
12. `npm run seed -w medusa` - seed Medusa DB
13. `npm run migrate -w medusa` - run Medusa migrations
14. `npm start` - build the Medusa plugin and start the Medusa dev server and Medusa plugin watcher

WordPress is now available at [https://medusawp.test](https://medusawp.test) and Medusa Admin dashboard at [http://localhost:9000/app](http://localhost:9000/app).

Expand Down Expand Up @@ -272,5 +274,5 @@ This project is licensed under the [MIT License](https://github.com/Agilo/medusa

== Credits ==

MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
MedusaWP is developed and maintained by [AGILO](https://agilo.co/).
Huge thanks to [all contributors](https://github.com/Agilo/medusawp/graphs/contributors).

0 comments on commit 15bbe23

Please sign in to comment.