An open API service indexing awesome lists of open source software.

https://github.com/adrianhdezm/ts-app-cli

CLI for creating applications based on typescript
https://github.com/adrianhdezm/ts-app-cli

boilerplates cli cli-app nodejs typescript vanilla-typescript xstate

Last synced: 2 months ago
JSON representation

CLI for creating applications based on typescript

Awesome Lists containing this project

README

        

# Typescript App CLI [![npm package](https://github.com/adrianhdezm/ts-app-cli/workflows/npm%20package/badge.svg)]

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

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

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

```sh
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](https://create-react-app.dev).

## License

TS App CLI is open source software [licensed as MIT](https://github.com/adrianhdezm/ts-app-cli/blob/master/LICENSE).