https://github.com/hivivo/teakettle

TeaKettle is a tool to make TEA (Typescript + Express JS + Angular 4 web apps) with Material flavors.
https://github.com/hivivo/teakettle

angular angular4 express expressjs generator material material-design tea typescript

Last synced: about 1 month ago
JSON representation

TeaKettle is a tool to make TEA (Typescript + Express JS + Angular 4 web apps) with Material flavors.

• Host: GitHub
• URL: https://github.com/hivivo/teakettle
• Owner: hivivo
• Created: 2017-07-20T04:51:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-31T06:23:49.000Z (about 7 years ago)
• Last Synced: 2024-05-28T19:15:13.951Z (6 months ago)
• Topics: angular, angular4, express, expressjs, generator, material, material-design, tea, typescript
• Language: JavaScript
• Size: 67.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## TeaKettle

TeaKettle is a tool to make TEA ([Typescript](https://www.typescriptlang.org) + [Express JS](https://expressjs.com) + [Angular 4](https://angular.io)) with [Material](https://material.angular.io) flavors.

Because of its special ingredients, TEA is a full stack Typescript solution for making

modern web apps.

TeaKettle is a command-line tool used to generate TEA projects based on [angular-cli](http://cli.angular.io/) and [ember-cli](http://www.ember-cli.com/) projects.

## Prerequisites

Both TeaKettle and generated TEA project have dependencies that require Node 6.9.0 or higher, together

with NPM 3 or higher.

## Table of Contents

* [Installation](#installation)

* [Usage](#usage)

* [Making TEA](#making-tea)

* [Upgrading TeaKettle](#upgrading-teakettle)

* [Documentation](#documentation)

* [License](#license)

## Installation

**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)

```bash

npm install -g teakettle

```

## Usage

```bash

teakettle help

```

### Making TEA

```bash

teakettle make PROJECT-NAME

cd PROJECT-NAME

teakettle serve dev

```

Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

### Upgrading TeaKettle

To update TeaKettle to a new version:

```bash

npm uninstall -g teakettle

npm cache clean

npm install -g teakettle

```

## Documentation

The documentation for TeaKettle is located in this repo's [wiki](https://github.com/hivivo/teakettle/wiki).

## License

MIT