A generator for my open source projects
This generator assumes you're using Yarn, please install it first.
Install yeoman:
yarn global add yoThen install this generator:
yarn global generator-bxd-ossAdd semantic-release-cli:
yarn global add semantic-release-cliInstall hub (if you want this generator to be able to create repositories for you):
brew install hubThen switch to the directory where you want to generate a new project, and run:
yo bxd-oss- Yeoman
- NodeJS
- Yarn
- Git
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
yarnAfter this, you can find the generator in generators/app alongside its
templates.
yarn linkThe above command links this generator into the global modules folder (just remember to unlink it after!).
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.
We base our code style on AirBnB's style guide and we check with ESLint and automatically format our code with Prettier.
This project is licensed under the MIT License - see the license file for details.
- Kent C. Dodds and his generator.
- Hive's project guidelines
- Open Source Guide
If you're interested in contributing to this project in any form, please read our Contribution Guidelines.
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.
Thanks goes to these people (emoji key):
 Adrian Perez 💻 📖 🚇 |
|---|
This project follows the all-contributors specification. Contributions of any kind welcome!