What is SugoiJS?

"Sugoi" - Awesome in Japanese. As the development process should be.

SugoiJS - A minimal modular framework,which gives you the ability to use only what you need, fast.

SugoiJS is a modular framework which gives you the ability to develop faster while using just what you need.

SugoiJS decreases the amount of boilerplate code while using abstraction and decorators syntax while using OOP and SOLID principles this without giving up FP abilities.

SugoiJS provides an easier definition of fows in your application with predefined lifecycle hooks. It helps you to get easier debugging and testing process.

The combination of TypeScript, decorators, abstractions and predefined lifecycles will optimize your development experience along with your application reliability.

SugoiJS has five root modules that act as standalone units:

  • @sugoi/core - This is the core module of SugoiJS, it defines utilities like policies (aka Filters), extendable exceptions, container handler (for singleton), service injection and much more! *The core module is imported and used by all of the SugoiJS modules.

  • @sugoi/server - The server module provides fully decorated express based web server with additional abilities like:

    • Service injection.

    • Request validators (params, body, query params, headers).

    • Authorization and roles validators.

    and much more!

  • @sugoi/orm - The ORM module is used for object-relational mapping. this module defines abstract models for REST usage and DB connection usage. As well as casting resources to class instances, the ORM module provides CRUD and lifecycle flow: before(CRUD),after(CRUD), beforeValidate,validate. - Sub-module of this module is @sugoi\mongodb.

  • @sugoi/socket - The socket module is an easy plug and play socket handler module which based on socket.io. This module gives you the ability to bind event to function using the @SocketOn(eventName) decorator on top of the function.

  • @sugoi/redis - The Redis module is an easy plug and play redis handler module. This module gives you the ability to handle Redis callbacks with promises, bind channel\pattern subscription events to function using the @OnRedisMessage(channel)/OnRedisPMessage(pattern)

    decorator on top of the function.

Try it now with our demo application

Last updated