README.md

Expressive Tea

A Clean, simple, modulable, extendable ExpressJS over Typescript framework.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Motivation
  • Features
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Setting Up Typescript
  • Examples
• Contributing
• Versioning
• Contributors
• Support
  • Principal Sponsors
• Stay on touch
• License
• Disclamers

About the project

Expressive Tea is framework to help build server-side applications in NodeJS and use modern Javascript powered by Typescript. As Expressive Tea is using express is compatible with all the middlewares and modules and provide an easy migration from express applications.

Expressive Tea is a flexible framework but also giving freedom to the developer to build their own architectures by providing descriptive decorators, a plugin engine, shareable modules and moder Javascript.

Motivation

Server-side applications it contains awesome tools, helpers, and libraries to improve productivity but at same time it haves a large downside, architecture. Expressive Tea main motivation is relief the stress of the architecture by providing a shareable/pluggable projects, you can write a plugin to setting up express middlewares, databases settings, or websockets to name some; and you can share them through your next projects or the community.

Main goal is making uncomplicaded creation of server-side applications, modulables, plugables, free and efortless architecture.

Features

• Easy Setting up and start up of webserver.
• Extends and configuration with plugins and well-defined boot stages.
• Modules are not hard dependencies and can be shareable between projects.
• Declare Server Middlewares configuration as hard or soft dependency at server level.
• Dependency Injection is available for controllers as providers declared in modules using InversifyJs.
• Declarative Router on Controllers.
• Declarative Verbs and Middlewares under module and verb level.
• Declarative Exceptions for a better Error Handling.

Built With

• Express - The web framework used
• Typescript - Main Language
• Inversify - Used for dependency Injection
• Reflect Metadata - Used to get code metadata.
• YARN - Used to build and dependencies.

Getting Started

Prerequisites

Important! Expressive Tea requires Node >= 6, Express >= 4, TypeScript >= 2.0 and the experimentalDecorators, lib compilation options in your tsconfig.json with the next configuration.

Expressive Tea is not having any configuration of any Express Plugin or any database connection beside is built it on Express it is woking as Bring Your Own Architecture.

Installation

npm i --save @zerooneit/expressive-tea

Setting up Typescript

{
  "compilerOptions": {
    "baseUrl": ".",
    "sourceMap": true,
    "noEmit": true,
    "noImplicitAny": true,
    "target": "es6",
    "lib": ["es6", "dom"],
    "module": "commonjs",
    "moduleResolution": "node",
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

Examples

You can looking into our simple example here, or edit or see how is working on our live preview using th button below.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Contributors

• Diego Resendez - Lead Developer / Author - zerooneit

See also the list of contributors who participated in this project.

Support

If you are experience any kind of issues we will be happy to help. You can report an issue using the issues page or the chat. You can also ask questions at Stack overflow using the expressive-tea tag.

If you want to share your thoughts with the development team or join us you will be able to do so using the official the mailing list. You can check out the wiki to learn more about Expressive Tea internals or check our documentation.

Expressive Tea is an open source project, our goal is create an awesome framework that helps to build marvelous server side applications. If you like to join as Sponsor or backer to continue grow, please you can contact us on [email protected]

Principal Sponsors

Stay on Touch

• Author - Diego Resendez
• Twitter - @expressive_tea
• Email - [email protected]

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details

Disclaimers

The banner and the logo is a derivate work Designed by Freepik