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

@autofleet/super-express

v5.0.0

Published

AF Express with built in boilerplate

Downloads

886

Readme

SuperExpress

SuperExpress is an enhanced Express.js server application with built-in middleware for logging, security, health checks, and more. This project aims to provide a ready-to-use Express.js server setup with configurable options.

Features

  • Logging: Uses Morgan for HTTP request logging.
  • Security: Adds various security headers.
  • Body Parsing: Configurable body parser with a high payload limit.
  • Health Checks: An endpoint to check if the server is alive.
  • Stats Endpoint: Provides server and application statistics.
  • Tracing: Supports request tracing.

Installation

To install the dependencies, run:

npm install

Usage

Importing and Initializing

To use SuperExpress, you need to import and initialize it in your application:

import createSuperExpressApp from './index.js';

const options = {
    bodyParser: true,
    helmet: true,
    morgan: true,
    nitur: true,
    stats: true,
    packageJsonPath: './package.json',
    tracing: true,
    eagerLoadUserPermissions: true,
    aliveEndpointOptions: { customOption: 'value' }
};

const app = await createSuperExpressApp(options);

app.listen(3000, () => {
    console.log('Server is running on port 3000');
});

Options

You can customize the behavior of SuperExpress by passing an options object:

  • bodyParser (boolean): Enables or disables the body parser middleware.
  • helmet (boolean): Enables or disables security headers.
  • morgan (boolean): Enables or disables HTTP request logging.
  • nitur (boolean): Enables or disables the alive endpoint.
  • stats (boolean): Enables or disables the stats endpoint.
  • packageJsonPath (string): Path to the package.json file for the stats endpoint.
  • tracing (boolean): Enables or disables request tracing.
  • eagerLoadUserPermissions (boolean): Enables or disables eager loading of user permissions for tracing middleware.
  • aliveEndpointOptions (object): Options to customize the alive endpoint.

Endpoints

Alive Endpoint

  • Path: /alive
  • Method: GET
  • Description: Checks if the server is alive.

Stats Endpoint

  • Path: /
  • Method: GET
  • Description: Provides server and application statistics.

Tests

This project uses Node.js's built-in test runner for testing. To run the tests, execute:

node --test index.test.js

Example

Here's an example of how to set up and run the server:

import createSuperExpressApp from './index.js';

const options = {
    bodyParser: true,
    helmet: true,
    morgan: true,
    nitur: true,
    stats: true,
    packageJsonPath: './package.json',
    tracing: true,
    eagerLoadUserPermissions: true,
    aliveEndpointOptions: { customOption: 'value' }
};

const app = await createSuperExpressApp(options);

app.listen(3000, () => {
    console.log('Server is running on port 3000');
});

Contributing

Feel free to submit issues or pull requests. Contributions are welcome!

License

This project is licensed under the MIT License.