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

dream-cli

v0.2.1

Published

The conversion dream store engine command line interface

Downloads

6

Readme

VTEX Dream CLI

Makes you a happy store developer :)

Installation

Make sure you have Node.js installed. Then:

$ npm i -g dream-cli

Commands

$ dream -h
Options:
  -h, --help     Show this help.
  -l, --login    Authenticate with VTEX ID.
  -d, --deploy   Deploy <your store> <version> on dream-engine. This will make your version go live!

Development setup

First, download an example store like DreamStore.

$ wget -qO- -O dreamstore-master.zip https://github.com/vtex/dreamstore/archive/master.zip && unzip dreamstore-master.zip && rm dreamstore-master.zip

Then, authenticate this machine with VTEX ID

$ dream login

Great, now we can start hacking at our new store. Inside the store directory, call dream:

$ cd dreamstore-master
$ dream

(...)

DE >> App started on port 1337 with environment development

Go to localhost:1337 and you will be able to navigate your local store.
Note that any changes to files under templates/ or public/ will issue a Livereload. Nice!

Deploying your store

To deploy your store, you must first publish it on npm. (Roadmap: private registries!)

To start, alter the version on your package.json to reflect your changes.
Note: you can use a tool like Releasy to automate this kind of procedure!

$ releasy
Old version: 0.3.0
New version: 0.3.1-beta
prompt: Are you sure?:  (yes)
Starting release...
Version bumped to 0.3.1-beta
File package.json added > git add package.json
File package.json committed > git commit package.json -m "Release v0.3.1-beta"
Tag created: v0.3.1-beta > git tag v0.3.1-beta -m "Release v0.3.1-beta"
Pushed commit and tags > git push --follow-tags
All steps finished successfuly.

Then, simply use publish via npm:

$ npm publish

Now, your store is available to dream-engine.
Use the deploy command to publish it live:

$ dream deploy
Deploying store
name: dreamstore
version: 0.3.1-beta
Deployed successfuly

If your version is a beta, it will be available at:

yourstore.dreambeta.vtex.io

Otherwise, it will be published to:

yourstore.dream.vtex.io

Hooray! Your store is live. Good sales! :)

Advanced deployment

You can also specify which environment you wish to deploy this version to:

$ dream deploy stable
Checking files...
Deploying store
name: dreamstore
version: 0.3.1-beta
environment: stable
Deployed successfuly

Now, version 0.3.1-beta is available at yourstore.dream.vtex.io