generator-bxd-oss

A generator for my open source projects

!Semantically Releasedsemantic-release-badgesemantic-release !Build Statusbuild-badgebuild !Code Coveragecoverage-badgecoverage !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !Styled with Prettierprettier-badgeprettier !AirBnB style guideairbnb-style-badgeairbnb-style
!MIT Licenselicense-badgelicense !PRs Welcomeprs-badgeprs !Commitizen friendlycommitizen-badgecommitizen !Code of Conductcoc-badgecoc
!Watch on GitHubgithub-watch-badgegithub-watch !Star on GitHubgithub-star-badgegithub-star !Tweettwitter-badgetwitter

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 SemVersemver for versioning. In addition, it's automatic via semantic-releasesemantic-release, and our commit conventioncommit-convention.
For the versions available, see the Releasesreleases on this repository.

Style guide

We base our code style on AirBnB's style guideairbnb-style and we check with ESLinteslint and automatically format our code with Prettierprettier.

License

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

Acknowledgments

• Kent C. Dodds and his

generator.

• Hive's project guidelines
• Open Source Guide

Contributing

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

Code of Conduct

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

Contributors

Thanks goes to these people (emoji keyemojis):
|
_{Adrian Perez}
💻 📖 🚇") ⚠️ | | :---: |
This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!