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

@financial-times/n-internal-tool

v8.0.0

Published

Simple wrapper around n-express to create a simple, internal web based tool

Downloads

118

Vulnerabilities

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

Links

Git

Maintainers

robgodfreyrobgodfreyrobertboultonrobertboultonseraph2000seraph2000hamza.samihhamza.samihnotleenotleeemmalewisemmalewisaendraaendrathe-ftthe-ftrowanmanningrowanmanningcheecheealexwilsonalexwilson

Keywords

Readme

n-internal-tool

Simple nodejs server intended for internal, web-based tools

Deprecated

Do not use n-internal-tool in new projects. Migrate away to use standalone express and the templating language you need in future.

Introducing

  • n-express - next's standard issue server, with error-handling, metrics, utility endpoints (e.g. /__about) and healthchecks built in
  • express-handlebars with a few additional helpers and optimization in the loading of partials
  • o-header-services - origami header for non user-facing websites

Options

  • options.viewsDirectory - directory containing your handlebars views (default /views)
  • options.partialsDirectory - array of directories containing your handlebars partials (default /views/partials)
  • options.defaultLayout - name of the default layout to use (default false)
  • options.layoutsDir - directory containing your handlebars layouts (default /node_modules/n-internal-tool/layouts)
  • options.helpers - map of handlebars helpers
  • options.systemCode - system code for the app
  • options.healthchecks - array of healthchecks for the app (see n-express for details)
  • options.extname - file extension of files to use as handlebars templates (default: '.html')

Modules

  • Router - Next's Express router
  • static - common static data
  • metrics - Next metrics
import express from `@financial-times/n-internal-tool`;

Data model

To render the header and nav set app.locals.header or res.locals.header to an object matching this structure:

{
	serviceName: 'Next code ombudsman',
	tagLine: 'As defined in section a), subsection 3biii',
	primaryNav: [
		{
			href: 'http://ft.com',
			text: 'next site'
		}
	],
	relatedContent: [
		{
			href: 'http://ft.com/signIn',
			text: 'sign in'
		}
	],
}

To include additional origami components via the build service set an object like the following as app.locals.origami

{
	css: '[email protected],[email protected]',
	js: '[email protected],[email protected]'
}

Custom document title

In the server of your own app, assign a string value to res.locals.title, which will be picked up within n-internal-tool's <head> tags and displayed in the browser tab.