@abxvn/builder

Table of contents

• Usage
  • Scaffold new code base
  • Commands
  • Customization
• Changelog
• Contribution

Usage

Scaffold new code base

Optionally, for yarn berry only and if you start with an empty repo, you can setup yarn berry by: yarn init -2

Pick one of these commands for the builder to setup necessary dependencies and code base:

pnpm dlx @abxvn/builder init
npx @abxvn/builder init
yarn dlx @abxvn/builder init

Usage: @abxvn/builder init [options]

Options:
  --path <path>  Specify root path for compilation (default: "current folder")
  --pm <name>    Optional package manager (choices: "pnpm", "npm", "yarn")
  -h, --help     display help for command

Commands

Documentation coming soon

Customization

Documentation coming soon

Changelog

See CHANGELOG.md

Contribution

All PRs and ideas for improvement are welcomed.

If you got any issues using this package, don't hesitate to create new 🐞 Bug report with a proper package:<name> label.

Feel free to clone this project, make changes that your feel necessary and pull request anytime you want.

Install dependencies and run development build

pnpm install
pnpm start

Working on your first Pull Request?

You can learn how from this free video series: How to Contribute to an Open Source Project on GitHub

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

Cheers 🍻