Project Title

Mautic Marketplace: Enhancing the marketplace!

Project description

This project will expand enable the marketer to interact more smoothly with those plugins and themes available in the Marketplace and also rate and reviews plugins they use!

Hello, here is the step by step guide to set you up with the project! The project is using Packagist API and Supabase basically it downloads the packages data from Packagist to Supabase because the Packagist has some limitations!

Installation

Follow the steps to setup it in your local!

1. Go to the Supabase website than click on "Start your project", and signup for a new account.

2. Click on new project after signup.

3. Name your project, generate and safely store your password. Select your region select free plan. Create a new project.

Run Locally

Clone the project

git clone https://github.com/mautic/mautic-marketplace.git

Go to the project directory

cd mautic-marketplace

Install dependencies

for mac os

brew install deno

with shell

curl -fsSL https://deno.land/install.sh | sh

enable these VS Code extensions.

Denoland and JavaScript and TypeScript Nightly by microsoft

Copy the .env.dist file and name it just .env. Fill in the SUPABASE_URL and SUPABASE_KEY values. This is required just for local development. In production this will be done in the cron job.

4. Install the SUPABASE CLI

for mac os you can run

brew install supabase/tap/supabase

after installing it

supabase login

If this fails, make sure you have just 1 organization.

supabase init

As the command suggests, go to .vscode/settings.json and enable deno: "deno.enable": true.

than go to the supabase/config.toml and change the API port from Supabase UI > Project Settings > DATABASE and your project_id from Supabase UI > Project Settings that you can find on project .

after that you can link your local project to the supabase

supabase link --project-ref refrence_id

Replace the refrence_id with the actual reference ID. deploy your project in supabase cli. You can skip the DB password step

Run supabase projects list to confirm you can see your project linked.

for that you have to open your docker in background

supabase functions deploy fetch_package

you will see your deployd function on your supabase account>edge function

Setting Up the Database Schema

supabase db push

Go to Table Editor, click on each table and click on the "RLS disabled" button and enable RLS.

Go to Database > Extensions. Search for "pg_cron" and "pg_net" and enable the extensions

-- SELECT cron.unschedule('invoke-function-every-minute');
select
  cron.schedule(
    'invoke-function-every-minute',
    '* * * * *', -- every minute (Change to 0 0 * * * for production)
    $$
    select
      net.http_post(
          url:='https://pmlsoukklacrbkqoyqmh.supabase.co/functions/v1/fetch_package',
          headers:='{"Content-Type": "application/json", "Authorization": "Bearer SERVICE_ROLE_KEY"}'::jsonb,
          body:=concat('{"time": "', now(), '"}')::jsonb
      ) as request_id;
    $$
  );

1. Replace the url with your edge function URL. Find it in the Supabase UI > Edge Functions.
2. Replace the SERVICE_ROLE_KEY with the key from Project Settings > API

Go to Edge Functions > Select your function > Logs to confirm the cron is running.

This will creat the tables and run other functions.

run the project

deno run --allow-env --allow-read --allow-net supabase/functions/fetch_package/index.ts

for testing run

deno test --allow-env --allow-read supabase/functions/tests/index_test.ts

API

Get the Anon key from Project Settings > API.

You can find the Database Functions under Database > Database Functions

Get packages

GET https://PROJECT_ID.supabase.co/rest/v1/rpc/get_view?apikey=ANON_KEY&_limit=30&_offset=0&_type=&_query=&_order=asc

GET https://PROJECT_ID.supabase.co/rest/v1/rpc/get_pack?apikey=ANON_KEY&packag_name=acquia/mc-cs-plugin-custom-objects