npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@platform-os/marketplace-kit

v2.8.3

Published

Make changes in your marketplace on PlatformOS

Downloads

132

Readme

Overview

Greenkeeper badge

Marketplace Kit is command line tool, which was developed to allow you to easily deploy your configuration files and assets to the PlatformOS. It expects you to follow a certain file structure in order to correctly communicate with the PlatformOS API. You do not have to use it, however it is highly recommended that you do. It is a CLI tool, hence you are expected to have basic knowledge in working with Terminal.

If you have any feature requests, feedback or problems please head over to the issues page and let us know.

All commands should be run in the project root directory - i.e. one level above marketplace_builder directory.

Requirements

marketplace-kit requires nodejs >= v8 to work properly. Read more on how to install node on your platform.

Installation and update

If your node is installed for all users you might need to use sudo to install npm packages globally:

sudo npm install -g @platform-os/marketplace-kit

If you are using nvm or node installed on your account, you can omit that:

npm install -g @platform-os/marketplace-kit

Usage

Adding environments and authenticating

Authentication is done with your Partner Portal account credentials. See this guide if you don't have Partner Portal account yet.

To add your environment to a config file, run the env add command, and authenticate with your Partner Portal credentials:

marketplace-kit env add [environment] --email <your email> --url <your marketplace url>

Example: marketplace-kit env add staging --email [email protected] --url https://example.com

Configuration for environments lays down in .marketplace-kit file.

Syncing changes

marketplace-kit sync [environment]

Example: marketplace-kit sync staging

Enables sync mode - immediately pushes changes made to filesystem to the proper environment. It feels like working on localhost. For obvious reason, it is dangerous to use on production, on a live marketplace - it is recommended to use it only for staging.

Deploying changes

marketplace-kit deploy [environment]

Example: marketplace-kit deploy staging

Deploys all the changes. It is recommended to first deploy to staging, test, and only then trigger to production. Effectively, deploy creates a zip file containning all your files and sends it to API. It is then processed in the background. Each zip file is stored by us, in order to allow you to rollback in case something goes wrong.

Deploying with force flag (-f or --force)

Force flag is used to override changes made in instance admin. If you see locked_by_admin error and you still want to deploy, use -f flag.

marketplace-kit deploy [environment] -f

Example: marketplace-kit deploy staging -f

Listing environments

If you forgot know what your environments are named or the url that is corresponding to any name, use:

marketplace-kit env list

Initializing required directory structure

If you need to create new project from scratch you can init directory structure using:

marketplace-kit init

It will download directory structure from official repository and extract it in your current directory.

We will try to keep it up to date and also keep it as useful as possible. If you have any feedback for directory structure go to github and create an issue.

Graphical interface

To start http server locally that will serve GUI use:

marketplace-kit gui serve [environment]

Example: marketplace-kit gui serve staging

GraphQL Browser

To explore your instance database using graphql open http://localhost:3333/gui/graphql in your web browser.

In the right sidebar there is a schema documentation should you need it.

Resources editor

To list, edit and create resources open http://localhost:3333/gui/editor in your web browser.