@lachiejames/generate-project
v1.2.1
Published
CLI tool for generating projects with predefined templates
Downloads
18
Maintainers
Readme
@lachiejames/generate-project
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
- Install this package globally:
npm install -g @lachiejames/generate-project
Navigate to the directory in which you want to create the new project (e.g. ~/Desktop):
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;