Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/expressive-tea/expresive-tea
A Simple, Clean, Flexible and Modulable web framework project, based on Express and Typescript
https://github.com/expressive-tea/expresive-tea
dependency-injection descriptive-decorators expressjs middlewares rest-api restful-api typescript
Last synced: 4 days ago
JSON representation
A Simple, Clean, Flexible and Modulable web framework project, based on Express and Typescript
- Host: GitHub
- URL: https://github.com/expressive-tea/expresive-tea
- Owner: Expressive-Tea
- License: apache-2.0
- Created: 2019-02-27T01:23:21.000Z (almost 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-25T05:06:21.000Z (8 months ago)
- Last Synced: 2024-04-26T04:32:04.344Z (8 months ago)
- Topics: dependency-injection, descriptive-decorators, expressjs, middlewares, rest-api, restful-api, typescript
- Language: TypeScript
- Homepage: https://expressive-tea.io
- Size: 2.22 MB
- Stars: 94
- Watchers: 4
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
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](#about-the-project)
* [Motivation](#motivation)
* [Features](#features)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Setting Up Typescript](#setting-up-typescript)
* [Examples](#examples)
* [Contributing](#contributing)
* [Versioning](#versioning)
* [Contributors](#contributors)
* [Support](#support)
* [Principal Sponsors](#principal-sponsors)
* [Stay on touch](#stay-on-touch)
* [License](#license)
* [Disclamers](#disclaimers)
## About the project
Expressive Tea is framework to help build server-side applications in [NodeJS](https://nodejs.org/) and use modern Javascript powered by
[Typescript](https://www.typescriptlang.org/). As Expressive Tea is using [express](https://expressjs.com/) 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](https://github.com/expressjs/express) - The web framework used
* [Typescript](https://www.typescriptlang.org/) - Main Language
* [Inversify](https://github.com/inversify/InversifyJS/) - Used for dependency Injection
* [Reflect Metadata](https://github.com/rbuckton/reflect-metadata) - Used to get code metadata.
* [YARN](https://yarnpkg.com/) - 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
```bash
npm i --save @zerooneit/expressive-tea
```
### Setting up Typescript
```json
{
"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](https://github.com/Expressive-Tea/expressive-tea-sandbox), or edit or see how is working on our live preview using th button below.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) 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/expresive-tea/tags).
## Contributors
* **Diego Resendez** - *Lead Developer / Author* - [zerooneit](https://github.com/zerooneit)
See also the list of [contributors](https://github.com/Expressive-Tea/expresive-tea/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](https://github.com/Expressive-Tea/expresive-tea/issues) or the [chat](https://gitter.im/Expressive-Tea/expresive-tea). You can also ask questions at [Stack overflow](http://stackoverflow.com/tags/expressive-tea) 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](https://groups.google.com/forum/#!forum/expressive-tea/). You can check out the
[wiki](https://github.com/Expressive-Tea/expresive-tea/blob/develop/README.md) to learn more about Expressive Tea internals or check our [documentation](https://docs.expressive-tea.io).
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]](mailto:[email protected])
#### Principal Sponsors
## Stay on Touch
* Author - [Diego Resendez](https://twitter.com/diegoresendez)
* Twitter - [@expressive_tea](https://twitter.com/expressive_tea)
* Email - [[email protected]]([email protected])
## License
This project is licensed under the Apache-2.0 License - see the [LICENSE](LICENSE) file for details
## Disclaimers
The banner and the logo is a derivate work [Designed by Freepik](http://www.freepik.com)