Skip to content

A collection of blueprint projects which illustrate various features of AMP Marketplace applications

Notifications You must be signed in to change notification settings

socotra/amp-blueprints

Repository files navigation

Socotra Marketplace feature blueprints.

A collection of blueprint projects which illustrate various features of Socotra Marketplace applications.

This repository contains example apps illustrating various Socotra Marketplace Application features. Each blueprint is a self-contained project that illustrates one of the features from Socotra Marketplace docs. You can read, play with or adapt from these samples to create your own applications using all listed features.

You can expect from each sample:

  • An explanation of its functionality
  • Link to a guide in Socotra MarketPlace documentation
  • Code of the same style
  • Correct app-manifest.json with minimal necessary configuration for the specific feature

Pre-requsites for all samples

Developer needs to have installed and configured:

All necessary commands are in "scripts" section of corresponding package.json and can be called via npm run command using your preffered terminal and shell. Some commands may need to be adjusted for shell-specific syntax. Examples below use bash shell syntax, which compartible with MacOS, Linux and Windows WSL default shells.

Usage

  • git clone https://github.com/socotra/amp-blueprints
  • code <blueprint-sample-folder> opens a sample folder in VSCode or open it in your favorite IDE.
  • Follow the instructions in each blueprint's README for setting up and running the sample

Getting Started

Developers can start with Socotra Marketplace Minimal app blueprint. It illustrates a minimal required set of endpoints and settings for a marketplace app. See Getting started documentation.

Blueprints

Sample Reference to docs Marketplace Features used Language
Minimal application Build an app -- Typescript
Application settings App Instance settings App.Fields Typescript
Product fields mapping Product fields mapping Socotra.Fields Typescript
Lifecycle events App lifecycle events Socotra.Lifecycle Typescript
Webhooks Webhooks Socotra.Webhooks, App.Fields Typescript

Notes

Format of this repository is heavily inspired by VSCode extension examples

License

About

A collection of blueprint projects which illustrate various features of AMP Marketplace applications

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published