https://github.com/expressive-tea/tea-cli
Expressive Tea CLI
https://github.com/expressive-tea/tea-cli
Last synced: about 1 year ago
JSON representation
Expressive Tea CLI
- Host: GitHub
- URL: https://github.com/expressive-tea/tea-cli
- Owner: Expressive-Tea
- License: apache-2.0
- Created: 2019-07-10T07:18:09.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-03T08:35:32.000Z (over 2 years ago)
- Last Synced: 2025-02-06T07:23:15.159Z (about 1 year ago)
- Language: TypeScript
- Size: 519 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Tea CLI
A CLI Tool for Expressive Tea applications.
Explore the docs »
Report Bug
·
Request Feature
## Table of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
## About The Project
Create an Expressive Tea server-side application with no build configuration with different flavors (templates). With this tool, you will not need to set up any tool or package; just run this, and you are good to go.
**Notice:** This is our first alpha version of this tool and is considered a work-in-progress stage; Even if this tool is useful to create new applications, it can fail or change behavior following implementations. Use it for production at your own risk.
### Built With
* [Typescript](https://www.typescriptlang.org/)
* [ShellJS](https://www.npmjs.com/package/shelljs)
* [Caporal](https://www.npmjs.com/package/caporal)
## Getting Started
To get started on the creation of Expressive Tea server side applications follow these simple steps.
### Installation
1. Install NPM packages
```sh
npm install -g @expressive-tea/tea
```
## Usage
### Create a new Application
To create an Expressive Tea application just need to run and follow the steps with the next command:
```sh
tea brew example
```
**Note:** as this tool is on early alpha dev we only have one complete template ready. As this tools advance to a stable
version we will continue adding, removing, upgrading and improving the current or new templates.
### Start Application
To start the Expressive Tea application use the next command inside of the project folder:
```sh
tea serve
```
## Roadmap
See the [open issues](https://github.com/Expressive-Tea/tea-cli/issues) for a list of proposed features (and known issues).
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Expressive-Tea/tea-cli/tags).
## License
This project is under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details
## Contact
Author - [Diego Resendez](https://twitter.com/diegoresendez)
Twitter - [@expressive_tea](https://twitter.com/expressive_tea)
Email - [support@expressive-tea.io](support@expressive-tea.io)
Project Link: [https://github.com/Expressive-Tea/tea-cli](https://github.com/Expressive-Tea/tea-cli)
## Disclaimers
The banner and the logo is a derivate work [Designed by Freepik](http://www.freepik.com)
[contributors-shield]: https://img.shields.io/github/contributors/Expressive-Tea/tea-cli.svg?style=flat-square
[contributors-url]: https://github.com/Expressive-Tea/tea-cli/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Expressive-Tea/tea-cli.svg?style=flat-square
[forks-url]: https://github.com/Expressive-Tea/tea-cli/network/members
[stars-shield]: https://img.shields.io/github/stars/Expressive-Tea/tea-cli.svg?style=flat-square
[stars-url]: https://github.com/Expressive-Tea/tea-cli/stargazers
[issues-shield]: https://img.shields.io/github/issues/Expressive-Tea/tea-cli.svg?style=flat-square
[issues-url]: https://github.com/Expressive-Tea/tea-cli/issues
[license-shield]: https://img.shields.io/github/license/Expressive-Tea/tea-cli.svg?style=flat-square
[license-url]: https://github.com/Expressive-Tea/tea-cli/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/Expressive-Tea
[product-screenshot]: images/screenshot.png