https://github.com/visormatt/generator

🤖 A Command Line Tool to speed up the creation of repetitive boiler-plate code.
https://github.com/visormatt/generator

build-tool cli ejs generator inquirer javascript nodejs react typescript

Last synced: about 1 month ago
JSON representation

🤖 A Command Line Tool to speed up the creation of repetitive boiler-plate code.

• Host: GitHub
• URL: https://github.com/visormatt/generator
• Owner: visormatt
• License: mit
• Created: 2018-12-02T20:33:28.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T13:56:59.000Z (over 1 year ago)
• Last Synced: 2024-07-02T04:21:43.084Z (3 months ago)
• Topics: build-tool, cli, ejs, generator, inquirer, javascript, nodejs, react, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@visormatt/generator
• Size: 1.98 MB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# 🤖 Generator

[![Monthly Downloads][image-npm-monthly]][link-npm]

[![Total Downloads][image-npm-total]][link-npm]

[![NPM Version][image-npm-version]][link-npm]

[![Dependabot][image-dependabot]][link-dependabot]

[![CodeCov][image-codecov]][link-codecov]

## Overview

This package was created to 🏎️💨 **SPEED** up the creation of `boilerplate` code & templates. It's easily configured and can be utilized across multiple projects. It can also be configured to share `templates` or each project can supply their own. Even better you can create your own templates using the [EJS][link-ejs] syntax.

> Checkout the [docs](./docs/README.md) folder for the project details.

## Installation

**Super simple** just install it like any other NPM package. The only caveat is the `--global` or `-g` flag which will install this `globally` for the version of NodeJS you're running. This is done to make use of the tool as a CLI script `generate` allowing you to generate templates anywhere!

```bash

# Global installation

npm i @visormatt/generator -g

# Run from the project root

generate:setup

# And now from anywhere

generate

```

[link-circle-ci]: https://circleci.com/gh/visormatt/generator/tree/master 'Circle CI'

[link-codecov]: https://codecov.io/gh/visormatt/generator 'Codecov'

[link-dependabot]: https://dependabot.com/ 'Dependabot'

[link-dependencies]: https://david-dm.org/visormatt/generator 'Dependencies'

[link-dev-dependencies]: https://david-dm.org/visormatt/generator?type=dev 'DevDependencies'

[link-ejs]: https://ejs.co/ 'ejs'

[link-inquirer]: https://github.com/SBoudrias/Inquirer.js 'Inquirer'

[link-nodejs]: https://nodejs.org/en/ 'nodejs'

[link-npm]: https://www.npmjs.com/package/@visormatt/generator 'NPM Package'

[link-react-up]: https://github.com/visormatt/generator-react-up 'React Up'

[link-typescript]: https://www.typescriptlang.org/ 'typescript'

[image-circle-ci]: https://circleci.com/gh/visormatt/generator/tree/master.svg?style=svg 'Circle CI'

[image-codecov]: https://codecov.io/gh/visormatt/generator/branch/master/graph/badge.svg 'Codecov'

[image-dependabot]: https://img.shields.io/badge/🤖dependabot-enabled-blue 'Dependabot'

[image-dependencies]: https://david-dm.org/visormatt/generator/status.svg 'Dependencies'

[image-dev-dependencies]: https://david-dm.org/visormatt/generator/dev-status.svg 'DevDependencies'

[image-npm-monthly]: https://img.shields.io/npm/dm/@visormatt/generator.svg 'Monthly Downloads'

[image-npm-total]: https://img.shields.io/npm/dt/@visormatt/generator.svg 'Total Downloads'

[image-npm-version]: https://img.shields.io/npm/v/@visormatt/generator.svg 'NPM Version'