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.jsonwith minimal necessary configuration for the specific feature
Developer needs to have installed and configured:
- Docker engine for your platform - official Docker installers.
- Node.js for your platform - official Nodejs installers.
- Latest version of Socotra's app-cli CLI.
- Install it globally via
npm install -g @socotra/app-cli - Authenticate a console session with
socotra-app login --client-id <clientid> --client-secret <secret>command, using clientID and Secret created in Socotra Marketplace (API Keys section )
- Install it globally via
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.
git clone https://github.com/socotra/amp-blueprintscode <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
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.
| 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 |
Format of this repository is heavily inspired by VSCode extension examples