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

surge-review

v1.1.1

Published

Deploy a static site to surge from CI & post the site to your pull request automatically :tada:

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

cdaringecdaringe

Keywords

Readme

surge-review :zap:

Greenkeeper badge

  • Deploys a static site to surge.sh
  • Adds a comment to your pull request with the new site URL :tada:

Codeship Status for cdaringe/surge-review semantic-release

install

npm install --save-dev surge-review

usage

$ surge-review

see surge-review -h for common options. generally, you will setup your CI server for your project to:

  • export github & surge tokens (SURGE_LOGIN, SURGE_TOKEN, & GH_TOKEN)
  • install this package
  • build your website
  • run surge-review to deploy to surge.sh & post a comment to github

support

  • gitlab is not yet supported. the api calls used are short and sweet. open a PR if you'd like to add it!
  • github enterprise is supported. see config options

configuration

required

  • SURGE_LOGIN, email address registered with surge
  • SURGE_TOKEN, token registered with surge
  • GH_TOKEN, github oauth token
  • GH_PROJECT, your CI should provide this.
  • GH_OWNER, your CI should provide this.
    • GH_PROJECT_OWNER, such as 'cdaringe/surge-review' can be used in exchange for the above two. for instance, codeship offers up CI_REPO_NAME, which === 'cdaringe/surge-review', so GH_PROJECT_OWNER=$CI_REPO_NAME works
  • GH_PULL_REQUEST
    • the number of your PR. this is the number at the end of your PR URL
    • this isn't strictly required--surge-review will try to search for the PR number *iff you also provide a GH_PULL_BRANCH

optional

  • BUILD_ID your <subdomain>.surge.sh is random by default. add this to make your subdomain surgereview${BUILD_ID}
  • GHE set to true if publishing to GitHub Enterprise
  • GH_DOMAIN default: github.com
  • GH_PROTOCOL default: 'https'
  • GH_FOLLOW_REDIRECTS default: false