@lachiejames/generate-project
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

@lachiejames/generate-project

npm version test pipeline codecov semantic-release

An interactive command-line tool to quickly setup new TypeScript projects. This includes installing the required dependencies and adding configuration files.

Requirements

This tool requires the following to be installed:

  • Node (v18+ to ensure compatibility with the latest versions of the installed packages)
  • Yarn
  • Git

Usage

  1. Install this package globally:
npm install -g @lachiejames/generate-project
  1. Navigate to the directory in which you want to create the new project (e.g. ~/Desktop):

  2. Then start the interactive setup:

generate-project

Demo

TODO: add demo

Development

Clone this project and open a terminal in the root directory.

Install dependencies:

yarn install

Build the project:

yarn build

Run unit tests:

yarn test

Run the project:

yarn start

This command both installs the package globally and then executes E2E tests:

yarn e2etest;

/@lachiejames/generate-project/

    Package Sidebar

    Install

    npm i @lachiejames/generate-project

    Weekly Downloads

    7

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    608 kB

    Total Files

    133

    Last publish

    Collaborators

    • lachiejames