1.0.6 • Published 5 years ago
koffiee v1.0.6
koffiee ☕
An automatic project generator for Node.js which creates a project with git
capabilities while you have your coffee.
Why?
Creation of a new project with git capabilities follows definite steps. koffiee is going to automate those steps so that you can create a new project in one command from your terminal instead of going through those steps all over again. These are the commands executed by koffiee by default.
Default mode of execution
- Create a new folder locally on the specified path
- Create a new Readme.md file
- Initialize folder with
git init
- Stage files to commit and commit files with
initial commit
- If remote is turned true,
- Log into https://github.com/<username>
- Create a new repository
- Return the remote url
- Add remote branch to local repo with
git remote add origin <remote>
- Open text editor with created local repo (visual studio code by default)
Note : You can change the command execution by altering the
scripts/commands.js
file which is in turn used to supply commands
Setup
npm install -g koffiee
koffiee setup
Here, you will be prompted to enter preferred common project directory, git username and password and will be stored in the .kfe
file in the root for creating remote repository in github later. It is essential to run setup before running the create script.
koffiee create [repository name] [flags]
flags : -a, --avoid : avoid executing commands flagged true in .config
-p, --private : create remote repository as private