Pkg
Stats

npm package discovery and stats viewer.

Discover Tips

General search
[free text search, go nuts!]
Package details
pkg:[package-name]
User packages
@[username]

Sponsor

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.

Twitter
@PkgStats
GitHub
pkgstats
Twitter
@ryanhefner
GitHub
ryanhefner
Site
ryanhefner.com

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 🙏

Framework
react / react-dom
Server
next / express / next-routes
Data Store
redux / react-redux / next-redux-wrapper / redux-thunk / redux-logger
Caching
lru-cache
CSS / Styling
next-page-transitions / styled-components
Typeface
@ibm/plex
Avatars
gravatar
Data Viz
chart.js / react-sparklines
Date formatting
dayjs
Infinite scrolling
react-scroll-trigger
Markdown rendering
react-markdown
Repository url parsing
hosted-git-info
User data
npm-user
Compiling
babel-plugin-module-resolver / babel-plugin-styled-components
Types
prop-types
Odds & Ends
es6-promise / isomorphic-fetch

© 2024 – Pkg Stats / Ryan Hefner

nestjs-readme

v0.1.3

Published

4 months ago

Generate README files automatically for Nest.js projects

Downloads

8

0High
0Medium
0Low

Nest.js README documentation

Generate basic README.md file for your Nest.js project

Installation

 npm install nestjs-readme

Usage

 npx nestjs-readme gen

generate/gen Generates README.md file for your project with default configuration
--help You can get more info about package's usage with this command

This package can help you to generate basic README for your Nest.js project by extracting information from your project such as

Title and description
Commands
Environment variables
Controllers

Title and Description

This package will look for title and description in package.json, otherwise it will add basic info.

Commands

This package will look for basic commands used in Nest.js projects, like "start" and "test" in your package.json's scripts section and if they are present, it will add them.

Environment variables

The following files ".env", '.env.production' and '.env.development' will be scanned for environment variables and if there are any variables, they will be added as well.The environment variables are expected to be in this format VARIABLE_NAME="value".

Controllers

This is Nest.js specific feature.If your project has Nest.js-like structure and has "./src/" folder, the package will look for controllers in each module and then list them readme with their endpoints with there parameters and paths.Note that GraphQL and other kind of APIs endpoints aren't supported yet.