https://github.com/andreruffert/booom

💥 A simple CLI to scaffold some files or folder structures to kickstart new projects
https://github.com/andreruffert/booom

cli scaffolding scaffolding-framework

Last synced: 12 months ago
JSON representation

💥 A simple CLI to scaffold some files or folder structures to kickstart new projects

• Host: GitHub
• URL: https://github.com/andreruffert/booom
• Owner: andreruffert
• License: mit
• Created: 2015-10-21T17:55:06.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-07-07T14:12:13.000Z (over 9 years ago)
• Last Synced: 2025-02-17T21:11:17.405Z (about 1 year ago)
• Topics: cli, scaffolding, scaffolding-framework
• Language: JavaScript
• Homepage: https://npm.im/booom
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# BOOOM!

[![Build Status](https://travis-ci.org/andreruffert/booom.svg?branch=master)](https://travis-ci.org/andreruffert/booom) [![npm version](https://img.shields.io/npm/v/booom.svg)](https://www.npmjs.com/package/booom)

> A simple CLI to scaffold some files or folder structures to kickstart new projects.

BOOOM! is a tool which helps to rapidly get started with a new project.

A common use cases would be to create some basic config files like e.g. `.editorconfig`, `.gitattributes`, `.gitignore` etc.

To create them every time manually can be really annoying. With `booom` it's just a simple terminal command and you can start coding immediately. "BOOOM!" that's it.

## Install

First thing is to install `booom` globally using `npm`:

```console

$ npm install --global booom

```

## Usage

```console

$ booom --help

  

  Usage:

    $ booom 

  Options:

    --help      Show information

    --version   Show current version

   should be a .zip file

  

  Examples

    $ booom https://github.com/andreruffert/booom--standard/archive/master.zip

```

## Scaffolding templates

A very simple scaffolding template could be e.g. [this](https://github.com/andreruffert/booom--standard/).

All files/folders located in the templates directory would be extracted to your current working directory (i.e. the directory from which you invoked the `booom` command).

## License

MIT © [André Ruffert](http://andreruffert.com)