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

generator-oss-project

v3.0.0

Published

Yeoman generator for open source projects.

Downloads

45

Readme

OSS Project Generator

Yeoman generator for open source projects.

NPM Version Downloads Travis Status CircleCI Status AppVeyor Status Coveralls Status License

This generator provides the following features:

  • src and test folder as a starter point to build your project.
  • esm as a simple, babel-less, bundle-less ECMAScript module loader.
  • EditorConfig to help you define and maintain consistent coding styles between different editors.
  • ESLint to provide a pluggable linting utility for JavaScript.
  • Prettier as an opinionated code formatter.
  • Jest as a complete and easy to set-up JavaScript testing solution used by Facebook.
  • Travis and CircleCI as a continuous integration and delivery platform.
  • Appveyor as a continuous delivery service for Windows.
  • Coveralls to help you track your code coverage over time, and ensure that all your new code is fully covered.
  • README.md and CHANGELOG.md with information about the project, installation, usage, development, author and license.
  • Badges for Travis, Appveyor, CircleCI, Coveralls, npm and License.

Project files

.
|--- src
|    |--- index.js
|--- test
|    |--- test.js
|--- .editorconfig
|--- .eslintignore
|--- .eslintrc.json
|--- .gitattributes
|--- .gitignore
|--- .npmrc
|--- .prettierrc
|--- .travis.yml
|--- appveyor.yml
|--- CHANGELOG.md
|--- circle.yml
|--- LICENSE
|--- main.js
|--- package.json
|--- README.md

Installation

  • Install Yeoman
$ npm install -g yo
  • Install Generator
$ npm install -g generator-oss-project

Usage

  • Creating a project
# Create a directory for your project
$ mkdir awesome-project

# Change into directory
$ cd awesome-project

# Generate a project
$ yo oss-project
  • Running project

| Action | Usage | | ---------------------------------------- | ------------------- | | Starting development mode | npm start | | Linting code | npm run lint | | Running unit tests | npm run jest | | Running lint + tests | npm test | | Running code coverage | npm run coverage | | Sending coverage results to Coveralls.io | npm run coveralls |

Development

Prerequisites

$ npm install -g yo

Clone the repo

$ git clone https://github.com/robertoachar/generator-oss-project.git

Run generator

# Change into directory
$ cd generator-oss-project

# Link generator
$ npm link

# Run generator
$ yo oss-project

Author

Roberto Achar

Contributors

Paulo Rezende

License

MIT