git-npx
v1.0.9
Published
TheFlyingCoders accelerator for quickly making git accelerators install-able with NPX
Downloads
2
Readme
🚨 This package is constantly improving, feel free to submit bugs and ideas! 🚨
TheFlyingCoder's Git npx
Initialising your accelerators with a single npx command!
If you are like me, you've got an accelerator you use ALL the time, maybe even multiple!
Whenever I wanted to share my accelerators, or re-use my own, it'd require cloning the repo from github, and that's about 6 clicks too many for my liking so instead I made this.
To try it out just use the npx installer:
npx git-npx <project-name>
What are the steps??
- Create your accelerator
- Put it on a public github repo
- Create the NPM installer package with
npx git-npx <project-name>
- Go into the package.json and update all the details, most importantly:
- name: This will be your npm installer package name
- bin/git-npx: Rename the key
"git-npx"
to match your package name - repository/url: This is what the code references to find your accelerator (Must be a .git url)
npm login
npm publish
- You are done!!
Try out installation of your new accelerator with npx <package-name> TestProject
Optional steps:
- Add a custom brand message in
scripts/brandMessage.js
so your installs have a personal touch - Add specific next steps in
scripts/nextStepsMessage.js
if it's not generic - CHANGE THE WHOLE THING HOWEVER YOU LIKE! :D Go into
git-npx.js
and play around