Table of Contents:

1. Introduction
2. Key Features
3. Project Structure
4. Prerequisites
5. Dependencies
6. Installation
7. Usage
8. License

Introduction

tafs-cli (Test Automation Framework Selection Command Line Interface) is a simple and intuitive tool for choosing and setting up your preferred automation framework for your projects. Whether you're working with Selenium or planning to explore Appium or API testing in the future, TAFS CLI has got you covered.

Key Features

• Framework Selection: Choose between Selenium, Appium (coming soon), and API testing (coming soon) for your automation needs.
• Language Support: Select your preferred programming language for automation, currently supporting JavaScript and Java.
• Quick Setup: TAFS CLI automates the setup process, including repository cloning and project initialization.
• Customizable: Easily extendable to support additional frameworks and languages in the future.

Project Structure

The project structure for TAFS CLI is as follows:

.
├── bin
│   └── index.js
├── package-lock.json
├── package.json
└── src
    ├── app.js
    ├── cloneRepos.js
    └── userPrompts.js

• bin: This directory holds the executable script(s) for the project. The index.js file serves as the entry point for running the application.

• src: This directory contains the source code of the project.

  • app.js: The main application logic resides in this file. It orchestrates the execution flow and integrates various modules.

  • cloneRepos.js: This file contains the functionality responsible for cloning repositories from remote sources. It encapsulates the logic for fetching and replicating repositories.

  • userPrompts.js: This file handles user input prompts and interactions. It ensures a smooth user experience by providing prompts for required information and guiding the user through the process.

• package-lock: This file defines metadata about the project and lists dependencies required for its execution.

• package-lock.json: This file is automatically generated and used to lock down the versions of dependencies installed. It ensures that the same versions of dependencies are installed across different environments, providing consistency in the project's execution.

Prerequisites

Before using taf-cli, you need to ensure the following prerequisites are met:

• node.js : Install Node.js, a JavaScript runtime environment.

• npm : Install npm, a package manager for Node.js.

• git : Install git, a version control system.

• Integrated Development Environment (IDE) : Install Visual Studio Code, an integrated development environment.

Dependencies

This project requires the following packages as dependencies:

• inquirer : A command line interface for selecting automation frameworks and languages.

• simple-git : A command line interface for cloning repositories.

• shelljs : A command line interface for executing shell commands.

• ora : A command line interface for displaying loading indicators.

• chalk : A command line interface for displaying colored text.

• figlet : A command line interface for displaying ASCII art text.

• boxen : A command line interface for displaying ASCII art text.

Note: The dependencies listed above will be installed automatically when you run npm install in the root directory of the project.

Installation

tafs-cli can be installed globally using npm.

• Run the following command:

npm install -g tafs-cli

To use tafs-cli using npx.

• Run the following command:

npx tafs-cli

Usage

To start using tafs-cli, simply run the below command from anywhere in your system.

tafs-cli

License

This project is licensed under the GPL License. See the LICENSE file for details.