Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 1.36 KB

README.md

File metadata and controls

41 lines (35 loc) · 1.36 KB
Raw

ts-project-gen

Easyest Type Script troject generator

Commitizen friendly code style: prettier

Motivation

This template is made with the goal of being able to create typescript projects directly from github. Existing project generators often require installation and configuration. This one is just a script that installs the necessary dependencies and self-deletes.

Requirements

  • BASH-environment
  • git
  • docker (optional)
  • node > 8
  • yarn
  • commitizen

Features

  • Prepared .gitignore
  • Yarn environment
  • Preconfigured scripts
  • Preinstalled Jest testing package
  • Building in slmall-sized Docker-container
  • Conventional Commit
  • ESLint
  • Prettier
  • Linting and prettyfying on commit

Usage

  1. Fork this repo if required
  2. Create new repo and select this one as template
  3. Clone this repo
  4. Run init.sh in bash environment and follow instructions
  5. That it

Contributing

Easy as cake

  1. Fork it
  2. Create repo or branch backup (This is done in case you accidentally run the init.sh)
  3. Edit it as you wand
  4. Pull request it