Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add README.md #1845

Merged
merged 1 commit into from
Jan 28, 2025
Merged

chore: add README.md #1845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions _dev/apps/verification-tag/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Verification Tag

The verification tag app is a crucial component of the PS Marketing module that handles Google site verification for PrestaShop stores.
A verification tag is an HTML meta tag used to confirm ownership of a website with Google services. It appears in the `<head>` section of your website's HTML and looks like this:

```html
<meta name="google-site-verification" content="your_verification_code" />
```

## Core Functionality

The verification tag app manages the verification process through several steps:

1. **Token Retrieval**: The app fetches a site verification token from PS Marketing API
2. **Token Storage**: Stores the verification token in the PrestaShop shop configuration
3. **Verification Process**: Handles the verification process with Google through PS Marketing API
4. **Website Claiming**: Claims the website with Google (with safety checks to prevent overwriting existing claims) through PS Marketing API
39 changes: 39 additions & 0 deletions _dev/apps/warning-messages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Warning Messages Application

## Overview
The Warning Messages application is a component of the PS Marketing module for PrestaShop. It provides merchants with real-time notifications about their configuration status directly in their BackOffice Dashboard.

### Purpose
- Notify merchants about configuration issues that need attention
- Provide actionable insights for account improvement
- Display clear, user-friendly warning messages with action buttons
- Help maintain optimal account configuration

### Tech Stack
- TypeScript
- Webpack
- Jest for testing
- Sentry for error tracking
- Integration with PS Marketing onboarding API

### Core Components
- `WarningElement`: Creates and manages warning message UI components
- Warning message generator
- Onboarding client integration
- Sentry error tracking

## Usage

The warning system automatically initializes when the merchant accesses their BackOffice Dashboard. It:
1. Checks for configuration issues
2. Displays relevant warning messages
3. Provides action buttons when applicable
4. Updates dynamically as configurations change

### Example Warning Message
```typescript
buildWarningMessages(["IT_APPEARS_THAT_YOU_HAVE_NOT_FINALISED_YOUR_CONFIGURATION"],{
isoCode: "en",
link: "configuration-page"
});
```
Loading