@chisel/steroids

Express on Steroids!

Steroids helps building backend solutions with Node.js, Express, and TypeScript by introducing new components that are easy and fast to develop.

Here's a quick list of features Steroids provides:

• TypeScript enabled
• Powered by Express
• Automatic code minification
• Logic is encapsulated into "Services" and router middlewares are grouped as "Routers"
• Routes are easily defined using the Router decorator
• Built-in input validation mechanism with routers (request body, headers, query parameters, etc.)
• Ability to extend the validation logic with custom validators
• Dynamic route and service installation
• Dynamic service injection without circular dependency issues
• Path alias support for easier imports
• Unit testing with Mocha and Chai
• TypeDoc ready

Installation

npm install @chisel/steroids -g

Steroids Framework

You can read the official documentation to learn how to use Steroids to develop backend solutions.

CLI Usage

After installing Steroids globally, the sd command will be available with the following options:

Creating a new project

Creates a new Steroid project:

sd new <name>

Creates a new minimal Steroid project (without tests and examples):

sd new <name> --minimal

Creates a new Steroid project without examples:

sd new <name> --skip-examples

Creates a new Steroid project without tests:

sd new <name> --skip-tests

Creates a new Steroid project and skips installing dependencies with NPM:

sd new <name> --skip-npm-install

Creates a new Steroid project and skips initializing git repository:

sd new <name> --skip-git

Creates a new Steroid project with verbose logs:

sd new <name> --verbose

Adding a router

Adds a new router in the default src/routers directory:

sd add router <name>

Adds a new router in a specific directory (relative to src):

sd add router <name> --directory <path>

Adds a new router without tests:

sd add router <name> --skip-tests

Adding a service

Adds a new service in the default src/services directory:

sd add service <name>

Adds a new service in a specific directory (relative to src):

sd add service <name> --directory <path>

Adds a new service without tests:

sd add service <name> --skip-tests

Listing all path aliases

Displays a list of all path aliases defined in tsconfig.json:

sd path list

Creating a new path alias

Defines a new path alias in tsconfig.json that will be resolved automatically upon running the project (target must be relative to src):

sd path new <alias> <target>

Deleting a path alias

Deletes a path alias from tsconfig.json:

sd path delete <alias>

Generating the documentation

Generates the TypeDoc developer documentation at /docs:

sd docs

Generated the TypeDoc developer documentation at /docs and serves it on the specified port (defaults to 7000):

sd docs --serve [port_number]

Building the source code

Builds the source into /dist:

sd build

Running the server

Runs the server on default port 5000:

sd run

Runs the server on a specific port with live reloading:

sd run --port <port_number> --watch