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

@icapps/tree-house-boilerplate

v1.0.4

Published

Tree House Boilerplate

Downloads

4

Readme

Treehouse boilerplate

NodeJS boilerplate module written in typescript

npm version Dependencies Build Status Coverage Status Greenkeeper badge

Usage

Clone this project

git clone [email protected]:icapps/tree-house-boilerplate.git

Copy code to new git project, commit and start making your new module

Typescript

The project is written in Typescript. More information can be found here.

TSlint

TSLint is an extensible static analysis tool that checks TypeScript code for readability, maintainability, and functionality errors. It is widely supported across modern editors & build systems and can be customized with your own lint rules, configurations, and formatters. More information can be found here.

NPM

Node Package Manager has been integrated to publish the package afterwards. Npm is the package manager for JavaScript and the world's largest software registry. This way these modules can be used within the actual NodeJS project using npm install.

Release

Releasing a new version of the module has been made easy using np.

npm run release

Travis CI

Travis CI is a hosted, distributed continuous integration service used to build and test software projects hosted at GitHub. There is a .travis.yml file included in the boilerplate. You still need to enable the module in Travis CI. This will allow you to run your tests and other checks for commits, pull requests and or merges automatically.

Coveralls

Ensure that all your new code is fully covered, and see coverage trends emerge. Works with any CI service. This way you can track the coverage progress for each commit and/or branch in a visual overview. You still need to enable the module in Coveralls.io. It will automatically be trigged as the last step in Travis CI described in the .travis.yml file.

Tests

All tests are written using Jest. Check out the documentation here for more information.

You can run npm run test to run all tests

You can run npm run test:coverage to run all tests with coverage report

Bugs

When you find issues, please report them:

Be sure to include all of the output from the npm command that didn't work as expected. The npm-debug.log file is also helpful to provide.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the ISC License - see the LICENSE.md file for details