Skip to content

CLI for creating applications based on typescript

License

Notifications You must be signed in to change notification settings

adrianhdezm/ts-app-cli

Repository files navigation

Typescript App CLI [npm package]

Typescript App CLI provides a simple way to start a project based on typescript using a very opinionated configuration for the file structure and development tools (i.e., Webpack, Prettier, TSLint, etc.)

How to use it

Currently, we support two types of templates, web for projects that will run in the browser (e.g., SPA) and node for the remaining environments (e.g., node webserver).

For creating a node-based project

npx ts-app-cli my-app
cd my-app
npm start

For creating a web-based project (i.e., Single-page application)

npx ts-app-cli -t web my-app
cd my-app
npm start

Motivation

In the past, we use to create boilerplates and example projects, mainly for building single-page applications, yet this has some limitations, such as adjusting the names, removing unnecessary code, etc. We don't think that only by using a CLI all the adapting a boilerplate process hassles can be easily solved. Nevertheless, it provides a mechanism to address some of them straightforwardly. For example, keep the dependencies updated and align the project name with a project folder, README.md, and package.json).

Acknowledgements

This projects is heavily inspired by Create React App.

License

TS App CLI is open source software licensed as MIT.