Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/heronlabs/vai-ts

Project created to initialize projects with Typescript
https://github.com/heronlabs/vai-ts

cli eslint github-actions gts jest nestjs npmjs prettier typescript yarn

Last synced: 3 months ago
JSON representation

Project created to initialize projects with Typescript

Host: GitHub
URL: https://github.com/heronlabs/vai-ts
Owner: heronlabs
License: mit
Created: 2021-04-03T20:48:10.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-08-31T17:39:04.000Z (5 months ago)
Last Synced: 2024-09-28T15:21:08.063Z (4 months ago)
Topics: cli, eslint, github-actions, gts, jest, nestjs, npmjs, prettier, typescript, yarn
Language: TypeScript
Homepage:
Size: 1.09 MB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# Vai TS

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![Build Status](https://github.com/heronlabs/vai-ts/actions/workflows/main.yml/badge.svg?branch=main)

#

[![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)](https://www.typescriptlang.org)

[![GTS](https://img.shields.io/badge/GTS-4285F4?style=for-the-badge&logo=google&logoColor=white)](https://github.com/google/gts)

[![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)](https://github.com/facebook/jest)

[![NestJS](https://img.shields.io/badge/nestjs-%23E0234E.svg?style=for-the-badge&logo=nestjs&logoColor=white)](https://docs.nestjs.com/)

[![NPM](https://img.shields.io/npm/v/@heronlabs/vai-ts?style=for-the-badge)](https://www.npmjs.com/package/@heronlabs/vai-ts)

> This is a project to launch other projects with Typescript

### Installation

```

npm install -g @heronlabs/vai-ts

```

### Usage

```

Usage: vai-ts [options] [command]

Options:

  -h, --help                                          display help for command

Commands:

  init-basic-boilerplate|i-basic [options]            Initialize with basic boilerplate

  version                                             Print current version

  init-api-store-boilerplate|i-api-store [options]    Initialize with API Store boilerplate

  init-api-broker-boilerplate|i-api-broker [options]  Initialize with API Broker boilerplate

  init-api-boilerplate|i-api [options]                Initialize with API boilerplate

  init-iac-boilerplate|i-iac [options]                Initialize with IaC boilerplate

  init-package-boilerplate|i-package [options]        Initialize with package boilerplate

  init-component-boilerplate|i-component [options]    Initialize with component boilerplate

  init-wcs-boilerplate|i-wcs [options]                Initialize with wcs boilerplate

  init-cron-boilerplate|i-cron [options]              Initialize with CRON boilerplate

  init-wcs-next-boilerplate|i-wcs-next [options]      Initialize with wcs next boilerplate

  init-cms-boilerplate|i-cms [options]                Initialize with CMS Headless boilerplate

  init-go-boilerplate|i-go [options]                  Initialize with Go boilerplate

  init-py-boilerplate|i-py [options]                  Initialize with Python boilerplate

  init-go-api-boilerplate|i-go-api [options]          Initialize with Go Api boilerplate

  help [command]                                      display help for command

```

## TLTR (Too long to read)

This project was created with the intention of acting as a CLI in creating new projects.

At first I used strings as the template format that would become the base files of the project to be created.

After using this tool and new knowledge I used git to clone new models, and the use of string became obsolete and unnecessary.

## How it works

The project is made available through a CLI that has some commands to generate new projects with different purposes.

Currently available templates are:

- [Basic Boilerplate](https://github.com/heronlabs/vai-ts-basic-boilerplate)

- [API Store Boilerplate](https://github.com/heronlabs/vai-ts-api-store-boilerplate)

- [API Broker Boilerplate](https://github.com/heronlabs/vai-ts-api-broker-boilerplate)

- [API Boilerplate](https://github.com/heronlabs/vai-ts-api-boilerplate)

- [IaC Boilerplate](https://github.com/heronlabs/vai-ts-iac-boilerplate)

- [Package Boilerplate](https://github.com/heronlabs/vai-ts-package-boilerplate)

- [Component Boilerplate](https://github.com/heronlabs/vai-ts-component-boilerplate)

- [WCS Boilerplate](https://github.com/heronlabs/vai-ts-wcs-boilerplate)

- [CRON Boilerplate](https://github.com/heronlabs/vai-ts-cron-boilerplate)

- [WCS Next Boilerplate](https://github.com/heronlabs/vai-ts-wcs-next-boilerplate)

- [CMS Boilerplate](https://github.com/heronlabs/vai-ts-cms-boilerplate)

- [Go Boilerplate](https://github.com/heronlabs/vai-ts-go-boilerplate)

- [Go API Boilerplate](https://github.com/heronlabs/vai-ts-go-api-boilerplate)

- [Python Boilerplate](https://github.com/heronlabs/vai-ts-py-boilerplate)

## Next steps

Insert new commands for new formats, such as: cli, api and Node packages.

## Built with

- [axios](https://github.com/axios)

- [unzipper](https://github.com/ZJONSSON/node-unzipper)

## Delivery from

- [NPM](https://www.npmjs.com/package/@heronlabs/vai-ts)