skeletapp
v1.0.1
Published
Package to create a new project from a template
Downloads
7
Readme
Skeletapp
A simple CLI tool to create a new project from a template.
Features
- Create a new project from a LOCAL template.
- Create a new project in the current folder.
- Create a new project in a folder of your choice.
- Fix the versions of the dependencies in the
package.jsonfile of your templates. - Create a new project from a REMOTE template.
Simple Usage without installing
- You can use the command
npx skeletapp <repository-url>in your terminal and:- Skeletapp will check that the repository you are trying to use is a valid GitHub repository. You can use either a full Github URL or a combination of the owner and the repository name. Example:
https://github.com/Ivluengo/skeletapporIvluengo/skeletapp. - Skeletapp will clone the repository, will show you the list of templates available in the repository and will ask you to choose one.
- Skeletapp will create the project in the folder you chose.
- Skeletapp will check that the repository you are trying to use is a valid GitHub repository. You can use either a full Github URL or a combination of the owner and the repository name. Example:
Usage installing Skeletapp locally
- Install Skeletapp locally by running the command
npm install -g skeletappin your terminal. - Skeletapp will create a global directory called
.skeletappin your home directory with atemplatesfolder inside. - Inside the
templatesfolder, add your own template folders.- When you will launch the tool, you will be asked to choose a template.
- Inside the template folder, add your own files.
- If you want Skeletapp to fix your package.json file, so whenever you create a new project from this template, the versions of the dependencies will be the latest ones, you need to add an asterisk (
*) to the version of the dependencies you want to be updated. - Recommended to delete the
package-lock.jsonfile so it won't collide with the versions Skeletapp will fix.
{
"dependencies": {
"react": "*",
"react-dom": "*"
}
}Extras
- You can also use the command
skeletapp add <template-path>in your terminal to add a template from any folder to the global directory. - You can also use the command
skeletapp add repo <repository-url>in your terminal all the templates from a remote repository to the global directory.- The url can be a full Github URL or a combination of the owner and the repository name. Example:
https://github.com/Ivluengo/skeletapporIvluengo/skeletapp.
- The url can be a full Github URL or a combination of the owner and the repository name. Example:
License
MIT
Author
Ivan Luengo
Thanks to Leonardo for the first idea and the first version a similar tool called template-cli.
