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

nodebee-frontend

v1.1.2

Published

A frontend for data logged by [NodeBee](https://github.com/netbymatt/nodebee). The data is plotted using [Plotly](https://github.com/plotly/plotly.js/).

Downloads

1

Readme

NodeBee Frontend

A frontend for data logged by NodeBee. The data is plotted using Plotly.

Requirements

This tool requires a dataset from NodeBee. Please follow the setup procedures there first as they are only referenced below.

Quick start

Server

  1. Clone this project to your server
git clone https://github.com/netbymatt/nodebee-frontend.git

Node.js app

  1. Open config.js
  2. Enter the database credentials, host name and database name in username, password, host and name. Then uncomment each line.
  3. Enter a port number to serve the application on.
  4. Start the server
npm start

Further details

The quick start routine is just that... a quick start. It has the following limitations:

  • Stores your database credentials in a file on the system against current best practices.
  • Ties up a terminal instance while running the server

Store configuration in environment variables

Storing your credentials in a file within the project is not considered a best practice. Instead environment variables should be used store this information. Environment variables that are shared with Nodebee are noted below. Nodebee-frontend uses the following environment variables to store configuration details:

config.js | Environment variable | Shared with Nodebee | default --- | --- | --- | --- db.username | NODEBEE_DB_USERNAME | yes | db.password | NODEBEE_DB_PASSWORD | yes | db.host | NODEBEE_DB_HOST | yes | localhost db.name | NODEBEE_DB_NAME | yes | nodebee server.port | NODEBEE_SERVER_PORT | no | 8080

After creating the environment variables make sure to clear out any stored credentials from config.js, or just delete the file entirely.

Run in the background

PM2 is recommended to run the process in the background, and start it automatically at boot. Use these commands to install PM2 and configure the process. If you've configured nodebee you may have already installed PM2, in which case you'll only ned to run step 2 and 4

# 1. install pm2
npm install -g pm2

# 2. start the nodebee process
pm2 server/index.js --name nodebee-frontend

# 3. restart pm2 automatically
pm2 startup
# 4. follow the instructions that this command outputs
pm2 save