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

svcready

v5.0.0

Published

> Service Ready: An opinionated Node.JS starter with Express, logging, and authenication

Downloads

2

Readme

svcready

Service Ready: An opinionated Node.JS starter with Express, logging, and authenication

Why

Each time I create a new API I generally end up re-implementing logging, error handling, websockets, and authentication.
I created this library to avoid having to solve these problems each time.

Installation

> yarn add svcready
> npm i svcready

Getting Started

import { create, logger } from 'svcready'

/**
 * These are functions implemented by you that create and get users and tokens
 * from your database.
 *
 * See the type definitions for their signatures
 */
import * as auth from './my-auth'
import { Router } from 'express'
import { someRouter } from './some-feature'
import { otherRouter } from './other-feature'
import { users } from './users'

/**
 * app: Express app
 * sockets: WebSocket server
 * - Sockets are authenticated on "upgrade"
 * - If the web client has an authenticated session, the socket will be authenticated on connection
 * - Reconnect them on the client after successfully authenticating to authenticate
 * - Use sockets.on('message', ...) to handle incoming messages
 * start: starts the HTTP server
 * stop: stops the HTTP server and websocket heartbeats
 */

const { app, sockets, start, stop } = create({
  // Express API port
  port: 3000,

  // Auth will only be provided if this config is provided
  auth: {
    // Session expiry in minutes
    expiryMins: 60,

    // Secret used for sessions
    secret: process.env.APP_SECRET,

    // (userId: string) => Promise<User | undefined>
    getUser: auth.getUser,
  },
  logging: {
    enabled: true,

    // Redact secrets before logging
    redact: ['password', 'accessToken'],
  },
})

const routes = Router()

routes.use('/some', someRouter)
routes.use('/other', otherRouter)
routes.use('/users', users)

app.use('/api', routes)

start()
  .then(() => logger.info('service ready'))
  .catch((ex) => {
    logger.error({ ex }, 'service failed to start')
    process.exit(-1)
  })

// ./users
import { Router } from 'express'
import { handle } from 'svcready'
import { createUser } from '../my-db/create-user'

const router = Router()

// Would normally be defined in another module
const register = handle(async (req, res) => {
  // Validate body...
  // Verify user id is available...
  const { username, password } = req.body

  const hash = await encrypt(password)

  // Creates a secure password hash and persists it
  await createUser(username, hash)
  res.json({ success: true })
})

router.post('/register', register)