Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 4 days ago
JSON representation

πŸ’₯ A simple CLI to scaffold some files or folder structures to kickstart new projects

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)