Kicking Off Hacktoberfest with ACM-VIT!

Boilerplate Generator

A CLI tool which generates boilerplate code for nodejs server applications taking in various configuration parameters.

Submitting a Pull Request

Fork the repository by clicking the fork button on top right corner of the page
Clone the target repository. To clone, click on the clone button and copy the https address. Then run
```
git clone [HTTPS-ADDRESS]
```
Go to the cloned directory by running
```
cd [NAME-OF-REPO]
```
Create a new branch. Use
```
 git checkout -b [YOUR-BRANCH-NAME]
```
Make your changes to the code. Add changes to your branch by using
```
git add .
```
Commit the chanes by executing
```
git commit -m "your msg"
```
Push to remote. To do this, run
```
git push origin [YOUR-BRANCH-NAME]
```
Create a pull request. Go to the target repository and click on the "Compare & pull request" button. Make sure your PR description mentions which issues you're solving.
Wait for your request to be accepted.

Guidelines for Pull Request

Avoid pull requests that :
- are automated or scripted
- that are plagarized from someone else's branch
Do not spam
Project maintainer's decision on validity of PR is final.

For additional guidelines, refer to participation rules and CONTRIBUTION.md

Overview

This CLI tool can be used to create boilerplate code for common backend frameworks. Authentication method, Framework of choice, Database of choice, and folder structure architecture can be passed on as arguments. Boilerplate code for Authentication functionality(Login/Register) is created in destination path provided.

Installation

Clone this repository

 git clone https://github.com/ACM-VIT/create-boilerplate-node.git

Go to cloned repository
```
 cd create-boilerplate-node
```
Install dependencies
```
 npm install
```
Make the script available system wide
```
 npm link
```

Usage

Go to repository directory.

Windows Powershell

 create-boilerplate-node.cmd [Target Directory] [Boilerplate type}

Linux/MacOs

 create-boilerplate-node [Target Directory] [Boilerplate type]

For example if you would want to create boilerplate code at ./test directory with jwt authentication with express mongoose and mvc architecture, you will use:

 create-boilerplate-node ./test express-mongoose-jwt

Authors

Kaushal Rathi

ACM-VIT / create-boilerplate-node

readme