@ou-imdt/create/readme.md

Command line tool to create team boilerplate.

# Create

[![npm version](https://badge.fury.io/js/@ou-imdt%2Fcreate.svg)](https://badge.fury.io/js/@ou-imdt%2Fcreate)

## Introduction

Create is a command line interface tool that assists in the creation of new widgets intended for distribution to the VLE.

The intention of the tool is to automate the creation of boilerplate code required by the VLE and provide a streamlined, modern, consistent and efficient development experience.

For the detailed boilerplate features, check the [boilerplate README file](./boilerplate/README.md).

## Features

- Creates a new widget with the boilerplate code, with two optional templates (Vanilla JS or VUE).
- Populates the README file, index.html and package.json with dynamic templating.
- Checks Node.js version and notifies if Long Term Support (LTS) version is not used.
- History to maintain the last input data like author `email`.


> Compatibility Note: Requires [Node.js LTS version](https://nodejs.org/en/download/). 

## Installation

```sh
npm install -g @ou-imdt/create 
```

### Update to the latest version

```sh
npm update -g @ou-imdt/create
```

## Usage

Run the `create` using:

```sh
create
```
Then answer the following questions to generate a boilerplate.

```sh
Template? (Vanilla Javascript/VUE.js)
Widget name?
Widget description?
Widget developer name? **
Widget developer email? **
Install deps? (yes/no)
```

** These will be fetched from git config, if they do not exist you will be prompted to enter them.


### Commands

```sh
help  Prints help info
```

### Options

```sh
-c, --clear    Clear the console Default: true
-v, --version  Print CLI version Default: false
```

## Changelog

❯ [Read the changelog here](./changelog.md)

## Issue reporting

- Use the issue tracker.
- Provide a clear and descriptive title.
- Describe the steps to reproduce the issue (for bugs).
- Explain the expected and actual behavior (for bugs).
- Describe why the feature is needed (for feature requests).

## Licence

This project is licensed under the MIT License - see the [LICENSE](./LICENCE) for details.

## Contributing

See [contributing](./contributing.md) for more details.

## Contact

Addison, Mustafa