gitbuilder v1.0.2
š Table of Contents
š§ About
gitBuilder.io is a simple CLI tool that I believe everyone should have installed on their dev machines. This tool, with it's extensible templates library, allows developers to get up and running very quickly and without all the boring environment and repository setup. gitBuilder.io will start by asking you a couple of basic questions about your project and then will give you a detailed breakdown of how it is building your project the entire way through. After your project is built, you are presented with all the details of your project and the location of your project on Github. At this point, you are ready to start coding! Just like that ššØ
š Usage
If you would like to download this tool for your own use, you may to so by downloading the package globally from NPM
npm install -g gitbuilder
Start the tool and follow the prompts to build your project
gitbuilder
š Getting Started with Development
If you would like to help out by adding your own templates or possibly some new features to the project, you can follow these steps.
Clone the project
You'll need to close the project to start working on it
git clone https://github.com/SystemFiles/gitbuilder-io.git
Prerequisites
First you will need to install a few things if you don't have them already.
Node
NPM
Installing
To install project dependencies you need only one command
npm install
Adding a Template
Adding a template is super easy. Simply copy the project you want to use as a template into the templates/projects/ folder. Then create a pull request so that we can add your template to the application in the next release!
ā ļø Please make sure your template is working and does not include any inappropriate content. ā ļø
Supported Languages: Python, NodeJS
Adding a Feature
Want to see something new in gitBuider.io? Well you can do so easily by cloning the repository
git clone https://github.com/SystemFiles/gitbuilder-io.git
then make your changes on a branch with the format feature/feature_name
or bugfix/name_of_bug_or_issue
git checkout -b feature/feature_name
then submit a pull_request
and I will make sure that your new feature is added.
ā ļø Please note: code changes/feature updates MUST follow the standard code style guidelines for which this project is following as well as pass all linting/tests in pull_request
before being merged with master
. ā ļø
š Submitting a bug report / issue
Please use an issue template provided. Create your report here