# happyflows

> HappyFlows: An intuitive, prompt-driven code generation CLI developed in NodeJS, designed to simplify and streamline your project initialization process.

Latest version **2.1.2** (published 2023-06-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install happyflows
pnpm add happyflows
yarn add happyflows
bun add happyflows
```

Provides the command `happyflow`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2023-06-19 |
| First published | 2023-05-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 233 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | therealovuruska |

## Links

- npm: https://www.npmjs.com/package/happyflows
- npm.io page: https://npm.io/package/happyflows

## Dependencies (9)

- [glob](https://npm.io/package/glob.md) ^10.2.7
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [openai](https://npm.io/package/openai.md) ^3.2.1
- [vectra](https://npm.io/package/vectra.md) ^0.1.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [langchain](https://npm.io/package/langchain.md) 0.0.95
- [configstore](https://npm.io/package/configstore.md) ^6.0.0
- [loading-cli](https://npm.io/package/loading-cli.md) ^1.1.0
- [@fortaine/fetch-event-source](https://npm.io/package/@fortaine/fetch-event-source.md) ^3.0.6

## Recent versions

- 2.1.2 (latest) — 2023-06-19
- 2.1.1 — 2023-06-17
- 2.1.0 — 2023-06-15
- 2.0.2 — 2023-06-15
- 2.0.1 — 2023-06-15
- 2.0.0 — 2023-06-14
- 1.0.3 — 2023-06-03
- 1.0.2 — 2023-05-30
- 1.0.1 — 2023-05-28
- 0.0.1 — 2023-05-27

## README

# HappyFlows: Prompt-Driven Code Generation
[![NPM](https://nodei.co/npm/happyflows.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/happyflows/)

![happyflow_logo](https://github.com/ovuruska/happyflows/blob/a6f86fe68cbb22bc5fc3e996595be90dfbb43fa6/docs/logo.png)

HappyFlows is a dynamic, prompt-based project bootstrapping library designed to streamline the project initiation process. It uses NodeJS and the command-line interface (CLI) to intuitively guide you through the setup process for your new projects, saving you time and effort.

## Table of Contents

- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Getting Started

HappyFlows aims to simplify the project setup process by generating tailored project templates based on your responses to a series of prompts.

## Installation

HappyFlows is a NodeJS based CLI tool. Make sure you have [NodeJS](https://nodejs.org/en/) installed in your environment.

To install HappyFlows globally on your machine, simply run:

```bash
npm install -g happyflows
```

## Usage

After successful installation, you can start a new project using HappyFlows by entering the following command:

```bash
happyflow
```

This will start a prompt asking you to explain your project in a few words, for example:

```bash
? Explain your program in a few words:  
Flask microservices: users, books and genres. They should be backed by PostgreSQL. Terraform and Kubernetes infra. Kafka as event broker.
```

Based on your input, HappyFlows will generate a relevant project structure to get you started!
Resulting structure will be like
```bash
.
├── books
│   ├── Dockerfile
│   ├── __init__.py
│   ├── k8s-deployment.yaml
│   ├── k8s-service.yaml
│   ├── main.py
│   └── requirements.txt
├── genres
│   ├── Dockerfile
│   ├── __init__.py
│   ├── genre_updated.avsc
│   ├── k8s-deployment.yaml
│   ├── k8s-resources
│   ├── k8s-service.yaml
│   ├── kafka-configmap.yaml
│   ├── kafka-deployment.yaml
│   ├── kafka-schemas
│   ├── kafka-service.yaml
│   ├── main.py
│   ├── main.tf
│   ├── namespace.yaml
│   ├── postgresql-sts.yaml
│   ├── requirements.txt
│   ├── terraform
│   ├── user_created.avsc
│   └── variables.tf
└── users
    ├── Dockerfile
    ├── __init__.py
    ├── k8s-deployment.yaml
    ├── k8s-service.yaml
    ├── main.py
    └── requirements.txt

```


## Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

---

Please let me know if you want to add or change anything.

---
_Source: https://npm.io/package/happyflows · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._