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

https://github.com/bottyivan/create-introfy

The CLI for Introfy that creates modern landing pages for your open source projects in minutes.
https://github.com/bottyivan/create-introfy

cli introfy nodejs scaffold template typescript

Last synced: 9 months ago
JSON representation

The CLI for Introfy that creates modern landing pages for your open source projects in minutes.

Awesome Lists containing this project

README

          

# create-introfy

> [!CAUTION]
> Some features of Introfy are still under development and may not be fully functional. Stay tuned for updates!

**create-introfy** is a CLI tool for rapid scaffolding of projects based on the [Introfy](https://github.com/BottyIvan/introfy) template.

## Features

- Clones the Introfy template from GitHub
- Interactive prompts for name, description, repo, and configuration
- Automatically installs dependencies
- Updates project configuration

## Installation

```bash
npm install -g create-introfy
```

## Usage

```bash
create-introfy
```

Follow the prompts to configure your new project.

## Local Development

1. Clone this repository
2. Install dependencies:

```bash
npm install
```

3. Start the CLI in development mode:

```bash
npm run dev
```

## Project Structure

- `src/cli/` — CLI entrypoint and user prompts
- `src/core/` — Scaffolding and configuration functions
- `src/utils/` — Utilities (git, install, prompt)

## Requirements

- Node.js >= 18

## License

This project is licensed under the [MIT](LICENSE) license.