Merge branch 'main' of https://github.com/trybeans/beans-woocommerce into release

Author: dlionel

.env.testing

@@ -1,22 +1,17 @@
-export WP_ROOT_FOLDER=wp
+export WP_ROOT_FOLDER=store
 
 export TEST_SITE_DB_DSN=mysql:host=127.0.0.1;dbname=beanswoocommercetestcases
 export TEST_SITE_DB_HOST=127.0.0.1
 export TEST_SITE_DB_NAME=beanswoocommercetestcases
 export TEST_SITE_DB_USER=beanswoocommercetestcases
 export TEST_SITE_DB_PASSWORD=Beans_WooCommerce_Testcases@0
-export TEST_SITE_TABLE_PREFIX=wp_51_wc_41_
+export TEST_SITE_TABLE_PREFIX=wp_58_wc_60_
 export TEST_SITE_ADMIN_USERNAME=beans
 export TEST_SITE_ADMIN_PASSWORD=beans
 export TEST_SITE_WP_ADMIN_PATH=/wp-admin
-export TEST_SITE_WP_URL=http://97a40f2a62b2.ngrok.io/wp
+export TEST_SITE_WP_URL=http://97a40f2a62b2.ngrok.io/store/
 export TEST_SITE_WP_DOMAIN=97a40f2a62b2.ngrok.io
 export TEST_SITE_ADMIN_EMAIL=radix+testcases-woocommerce@trybeans.com
 
-export TEST_DB_NAME=beanswoocommercetestcases
-export TEST_DB_HOST=127.0.0.1
-export TEST_DB_USER=beanswoocommercetestcases
-export TEST_DB_PASSWORD=Beans_WooCommerce_Testcases@0
-export TEST_TABLE_PREFIX=wp_51_wc_41_
 export TEST_STRIPE_SECRET_KEY=sk_test_51JLXBpAsdXfS9W1Ad6yxyTgX0CWFldkwLsxnHWkKzvlKJMr3245bmJV01a8jdSxqPbJp0C6MvFR9Fy0CHDh4cShe00fCBGaUdy
 export TEST_STRIPE_PUBLIC_KEY=pk_test_51JLXBpAsdXfS9W1AuwJWt6LOK1JNh4PWkg5WtrzqHuHRKc42dxPBA3yrhU3MwIlFVZEnHlXOJmYDB0b4pKXTibXT00j0JRVkVq

.github/workflows/release-wordpress.yml

@@ -0,0 +1,23 @@
+name: Deploy to WordPress.org
+on:
+  push:
+    tags:
+    - "v*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Build
+        run: |
+          bash build.sh
+
+      - name: WordPress Plugin Deploy
+        uses: nk-o/action-wordpress-plugin-deploy@master
+        env:
+          SVN_PASSWORD: ${{ secrets.WORDPRESS_SVN_PASSWORD }}
+          SVN_USERNAME: ${{ secrets.WORDPRESS_SVN_USERNAME }}
+          SOURCE_DIR: dist/
+          SLUG: beans-woocommerce-loyalty-rewards

.gitignore

@@ -23,11 +23,15 @@ vendor
 wp
 _local
 .vscode
+dist/
 
 tests/_output/
 tests/_support/_generated/
 src/src
 src/log.txt
+.env
 .env.local
 beans-woo-env/*
-.history
+.history
+store
+phpinfo.txt

README.md

@@ -1,30 +1,52 @@
 # Beans for WooCommerce
 
-### Prerequisite
+## 🔨 Prerequisite
 
-- You need to make sure that you have mysql installed and that `mysql` is available in your path 
+- You need to make sure that you have mysql installed and that `mysql` is available in your path.
 To check that you can run `which mysql`
 
-
-### 1. Install Composer 
-
+- If you don't have [composer](https://getcomposer.org/doc/00-intro.md), you will need to install it:
+ 
 ```shell script
 php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
 php composer-setup.php --filename=composer
 php -r "unlink('composer-setup.php');"
 ```
-If you are having trouble to find out more about it here: https://getcomposer.org/doc/00-intro.md
 
-### 2. Install dependencies 
+- Install all dependencies using composer:
 
 ```shell script
 ./composer install
 ```
 
-### 3. Running Linters 
+## ⏯ Develop 
+
+1. Create a local tunnel for localhost on port 8800 using ngrok.io
+```shell script
+ngrok http 8800
+```
+
+2. Copy `.env.testing` to .`env.local` and update env vars.
+
+
+3. If needed reset any existing testing configuration 
+```shell script
+./composer test-reset
+```
+
+4. Launch the web server
+```shell script
+./composer run-script start
+```
+
+Visit the address given by the localtunnel
+Wordpress admin username and password are `beans`
+
+## 🧽 Linting 
+
 To run all linters:
 ```shell script
-./composer run-script lint      
+./composer run-script lint
 ```
 
 To only run phpcs, 
@@ -36,24 +58,62 @@ To only run phpcs,
 To only run phpstan, 
 
 ```shell script
-./vendor/bin/phpstan analyze --memory-limit=100
+./vendor/bin/phpstan analyze --memory-limit=200M
 ```
 
 To reformat the code:
 ```shell script
 ./vendor/bin/phpcbf
 ```
 
+Ensure that your code is well documented:
 
-### 4. Develop 
+https://stackoverflow.com/questions/1310050/php-function-comments
+https://www.phpdoc.org/
+https://phpdocu.sourceforge.net/howto.php
+https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.param.pkg.html
+https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/
 
-```shell script
-./composer run-script start
+## 🧪 Testing 
+
+to be completed...
+
+## 🐞 Debugging 
+
+Install [Xdebug](https://xdebug.org/) to debug your php code. 
+Follow the wizard step here: https://xdebug.org/wizard
+
+To get PHPInfo:
+
+```bash
+php -f scripts/phpinfo.php > phpinfo.txt
 ```
- 
- Wordpress admin username and password are `beans`
 
- 
-### 5. Testing 
+Open `phpinfo.txt` to read the output.
+
+
+To create pot file:
+```bash
+./vendor/bin/wp i18n make-pot src src/i18n/beans-woocommerce.pot --exclude=src
+```
+
+To create mo file:
+```bash
+./vendor/bin/wp i18n make-mo src/i18n
+```
+
+Translated strings can be downloaded from [WordPress Translation platform](https://translate.wordpress.org/projects/wp-plugins/beans-woocommerce-loyalty-rewards/)
+
+
+## 📕 Documentation
+
+- [WooCommerce minimum requirements by version](https://woocommerce.com/document/update-php-wordpress/)
+- [WooCommerce versions](https://developer.woocommerce.com/releases/)
+- [WooCommerce REST API](https://woocommerce.com/document/woocommerce-rest-api/)
+- [WordPress minimum requirements by version](https://make.wordpress.org/core/handbook/references/php-compatibility-and-wordpress-versions/)
+- [PHP supported versions](https://www.php.net/supported-versions.php)
+
 
+Useful links 
+- Debugging WP 404: https://gist.github.com/yunusga/33cf0ba9e311e12df4046722e93d4123