npm install package from github repo subfolder

Question

Is it possible to install npm package from github when the package located inside subfolder?

For example, we have Microsoft BotBuilder repository: https://github.com/Microsoft/BotBuilder

But I need to install package inside subfolder "Node/core/": https://github.com/Microsoft/BotBuilder/tree/master/Node/core/

So how can I install it with npm?

Answer 1

Add to package.json:

... "scripts": {   "postinstall": "mkdir BotBuilder; cd BotBuilder; git init; git remote add -f origin https://github.com/Microsoft/BotBuilder.git; git config core.sparseCheckout true; echo \"Node/core\" >> .git/info/sparse-checkout; git pull --depth=1 origin master; cd ..; npm i ./BotBuilder/Node/core/"   ... }, ... 

postinstall script is running after the package is installed.

And step by step:

1. Make folder to clone repo: mkdir BotBuilder
2. enter to the folder: cd BotBuilder
3. init git repo: git init
4. set git origin to Microsoft/BotBuilder repo: git remote add -f origin https://github.com/Microsoft/BotBuilder.git
5. enable sparse checkout: git config core.sparseCheckout true
6. add Node/core to checkout list: echo "Node/core" >> .git/info/sparse-checkout
7. pull part of repo: git pull --depth=1 origin master
8. enter to Your app folder: cd ..
9. install BotBuilder: npm i ./BotBuilder/Node/core/

Answer 2

Paste the github link to the subfolder into gitpkg. You can then use this along with yarn or npm to install the package from a github sub folder.

https://gitpkg.now.sh/