<p style="text-align: center;" align="center" <img src="./logo.png"/ </p
Lightfold - lightweight scaffolding and archiving tool.
I built lightfold as a lightweight variant to more powerful but more complex tools such as Yeoman which are overkill for personal use. Lightfold allows users to simply and quickly zip archive a directory, and at a later date, that archive can be deployed to another location. There is also support to run custom code after unzipping for additional customization logic. This makes it easy to quickly build custom project scaffolds or starter code without having to deep-dive into the complexities of making a generator.
Setup
#### Prerequisites
This tool relies on Node.js, recommended with v12 and above. Older versions will likely still work but would have been untested.
Recommended setup is to go to https://nodejs.org/en/ and download the LTS version.
This tool is a command line interface (CLI), therefore relies on a terminal to interact with. Supported terminals are:
- Mac OS:
- Terminal.app
- iTerm
- Windows:
- cmd.exe
- Powershell
- Cygwin
- Linux (Ubuntu, openSUSE, Arch Linux, etc):
- gnome-terminal (Terminal GNOME)
- konsole
Note, lightfold's underlying interaction provider (inquirer.js) has posted a note about windows support:
Running Inquirer together with network streams in Windows platform inside some terminals can result in process hang. Workaround: run inside another terminal. Please refer to the https://github.com/nodejs/node/issues/21771
#### Installation
This utility is distributed through the Node package manager. With Node installed, you can install by running in your terminal: npm install -g lightfold
Alternatively, if you are comfortable with NPM, you can choose to download the source code, install relevant dependencies with npm install and install the CLI with npm link.
This will install lightfold as a global package. After installation, you should be able to call lfold -v to see the current version. For example:
andrewxia@MacBook example % lfold --version
v1.0.0If you are not able to see the expected response, please ensure npm packages are on your system's path. Additional information can be found here: https://www.tutorialspoint.com/nodejs/nodejsenvironmentsetup.htm