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

@vtex/sales-app

v3.11.0

Published

Package that contains the CLI and base site to enable estensibility points on Sales App

Downloads

616

Readme

@vtex/sales-app

This repository contains the base configuration to create extensible poins inside VTEX Sales App

What's here?

  • A CLI to create a template, test locally and build your extension point to Sales App
  • A Webpack site configured to exposes the extension points using mudle-federation
  • Type definitions about Sales App extension points

Sales App CLI

USAGE
  $ sales-app [COMMAND]

COMMANDS
  build   Build your Sales App Extension Points
  create  Creates the Sales App project base structure
  dev     Start your Sales App in development mode
  help    display help for sales-app

Create Command

Creates the base structure for Sales App project

USAGE
  $ sales-app create [PATH]

ARGUMENTS
  PATH  [default: sales-app] the path where the Sales App should be created

DESCRIPTION
  Creates the base structure for Sales App project

EXAMPLES
  $ sales-app create {my_custom_path}

Dev Command

Start your Sales App in development mode

USAGE
  $ sales-app dev ACCOUNT [PATH] [PORT]

ARGUMENTS
  ACCOUNT  the account for which the dev environment should run
  PATH     [default: sales-app] the path where the Sales App is located
  PORT     [default: 5413] the first port number allocated to Sales App

DESCRIPTION
  Start your Sales App in development mode

EXAMPLES
  $ sales-app dev {account}

Build Command

Build your Sales App Extension Points

USAGE
  $ sales-app build ACCOUNT [PATH]

ARGUMENTS
  ACCOUNT  the account for which the dev environment should run
  PATH     [default: sales-app] the path where the Sales App is located

DESCRIPTION
  Build your Sales App Extension Points

EXAMPLES
  $ sales-app build {account}

Debug mode

To enable debug mode, simply set the environment variable SALES_APP_DEBUG=true, for example:

$ SALES_APP_DEBUG=true sales-app {command}

How to test the CLI locally

Setup

  • Go to instore-core/packages/sales-app-extensions
  • Run yarn link to create the yarn package link locally
  • Run yarn build to build the project
  • Start an empty nodejs project running yarn init -y outside the instore-core folder
  • Go to your empty project and run yarn link @vtex/sales-app to link the package dep in your project

Commands

You can execute the CLI commands running like this example:

$ node_modules/@vtex/sales-app/bin/dev.js dev vtexinstoredev