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-bxd-oss

v1.6.0

Published

A generator for my open source projects

Downloads

11

Vulnerabilities

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

Links

Git

Maintainers

blackxoredblackxored

Keywords

open sourceblackxoredyeoman-generatorsemantic-releasebabelwebpacktraviscommitizencommitlintjest

Readme

generator-bxd-oss

A generator for my open source projects

Semantically Released Build Status Code Coverage version downloads Styled with Prettier AirBnB style guide

MIT License All Contributors PRs Welcome Commitizen friendly Code of Conduct

Watch on GitHub Star on GitHub Tweet

Installing / Getting Started

Pre-requisites

This generator assumes you're using Yarn, please install it first.

Install yeoman:

yarn global add yo

Then install this generator:

yarn global generator-bxd-oss

Add semantic-release-cli:

yarn global add semantic-release-cli

Install hub (if you want this generator to be able to create repositories for you):

brew install hub

Then switch to the directory where you want to generate a new project, and run:

yo bxd-oss

Developing

Built With

  • Yeoman

Pre-requisites

  • NodeJS
  • Yarn
  • Git

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/blackxored/generator-bxd-oss
cd generator-bxd-oss
yarn

After this, you can find the generator in generators/app alongside its templates.

Testing the generator without publishing

yarn link

The above command links this generator into the global modules folder (just remember to unlink it after!).

Versioning

We use SemVer for versioning. In addition, it's automatic via semantic-release, and our commit convention.

For the versions available, see the Releases on this repository.

Style guide

We base our code style on AirBnB's style guide and we check with ESLint and automatically format our code with Prettier.

License

This project is licensed under the MIT License - see the license file for details.

Acknowledgments

Contributing

If you're interested in contributing to this project in any form, please read our Contribution Guidelines.

Code of Conduct

We've adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributors

Thanks goes to these people (emoji key):

| Adrian Perez💻 📖 🚇 ⚠️ | | :---: |

This project follows the all-contributors specification. Contributions of any kind welcome!