{"id":25994818,"url":"https://github.com/industryswarm/blackrock","last_synced_at":"2026-05-28T21:31:21.284Z","repository":{"id":57277003,"uuid":"284554196","full_name":"Industryswarm/blackrock","owner":"Industryswarm","description":"Blackrock Application Server","archived":false,"fork":false,"pushed_at":"2021-02-06T01:56:06.000Z","size":5758,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-11-03T21:40:28.003Z","etag":null,"topics":["application-server","apps","blackrock","industryswarm"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Industryswarm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-02T22:41:22.000Z","updated_at":"2021-02-10T08:47:37.000Z","dependencies_parsed_at":"2022-08-25T04:12:24.384Z","dependency_job_id":null,"html_url":"https://github.com/Industryswarm/blackrock","commit_stats":null,"previous_names":["industryswarm/isnode-blackrock"],"tags_count":7,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Industryswarm%2Fblackrock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Industryswarm%2Fblackrock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Industryswarm%2Fblackrock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Industryswarm%2Fblackrock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Industryswarm","download_url":"https://codeload.github.com/Industryswarm/blackrock/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242048568,"owners_count":20063404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["application-server","apps","blackrock","industryswarm"],"created_at":"2025-03-05T15:17:01.995Z","updated_at":"2026-05-28T21:31:21.249Z","avatar_url":"https://github.com/Industryswarm.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Blackrock Application Server\n\n###### \u003cbr/\u003e\n\n### Introduction\n\nWelcome to the Blackrock Application Server. Blackrock has a Reactive / Event-Driven Architecture, and contains all the functionality you need to build your next Node.JS application, whether it be a web app, web service or something else.\n\n\u003cbr/\u003e\n\n### Installing Blackrock\n\n#### As a Stand-Alone Application Server\n\n\nBlackrock can be installed as a stand-alone application server on your system. All you need to do is to [Install Node.JS and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm \"Install Node.JS and NPM\") and then open up a command-line prompt and type:\n\n    \u003e npm install -g is-blackrock\n\n\n#### As a Dependency For Your Own Application\n\n\nBlackrock can be installed as a dependency within your own Node.JS application. All you need to do is to [Install Node.JS and NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm \"Install Node.JS and NPM\"), make sure you have a new or existing Node.JS application and then open up a command-line prompt and type:\n\n    \u003e cd /path/to/your/node.js/application\n\n    \u003e npm install --save is-blackrock\n\nAnd then open up your project in your favourite IDE and (most likely in the Javascript file you launch with) include a reference to this dependency:\n\n    const blackrock = require('is-blackrock').init();\n\nNote: If the application isn't new (more than just a scaffold) then you have to realise the Blackrock takes over the process and instantiates its own HTTP interface (and so on). As such you may very well have to re-engineer much of your application to work with Blackrock. Also - you may need to alter the server's configuration. See {@tutorial server-configuration} for more information.\n\nAlso: the is-blackrock node module has ZERO dependencies. So your risk of losing access to any of your packages is minimised.\n\n\u003cbr/\u003e\u003cbr/\u003e\n\n\n### Getting Started\n\nSee the [Getting Started Tutorial](https://blackrock.industryswarm.com/docs/tutorial-getting-started.html \"Getting Started Tutorial\") for a quick and easy guide to help you get started building with Blackrock.\n\n\u003cbr/\u003e\n\n### Modules Specifications\n\n*Below you can find the specifications for each Blackrock module:*\n\n| Module                                                                                                                                   | Description                                                                                                                                                                              |\n| -----------                                                                                                                              | -----------------------------------------------------------------------------------------------------                                                                                    |\n| [CLI Module](https://blackrock.industryswarm.com/docs/Server.Modules.CLI.html \"CLI Specification\")                                        | Manages execution of server actions based on command-line arguments provided at startup                                                                                                  |\n| [Configure Module](https://blackrock.industryswarm.com/docs/Server.Modules.Configure.html \"Configure Specification\")                         | Provides methods and command line tools to manage server and service configuration                                                                                                       |\n| [Core Module](https://blackrock.industryswarm.com/docs/Server.Modules.Core.html \"Core Specification\")                                     | Primary dependency (application server instance) that is exported to service routes and linked applications. Loads and provides access to all other modules and interfaces               |\n| [Daemon Module](https://blackrock.industryswarm.com/docs/Server.Modules.Daemon.html \"Daemon Specification\")                               | Provides tools to instantiate the application server as a daemon and to manage the daemon                                                                                                |\n| [Data Module](https://blackrock.industryswarm.com/docs/Server.Modules.Data.html \"Data Specification\")                                     | Provides a standard abstraction to third-party databases, and has a built-in filesystem JSON-based database that you can use to quickly build and prototype applications and services    |\n| [ErrorHandler Module](https://blackrock.industryswarm.com/docs/Server.Modules.ErrorHandler.html \"ErrorHandler Specification\")             | Provides the tools to intercept and handle application server exceptions and prevent the server from crashing                                                                            |\n| [Farm Module](https://blackrock.industryswarm.com/docs/Server.Modules.Farm.html \"Farm Specification\")                                     | Provides the tools to share state within a distributed compute cluster or farm. And to manage job processing without duplication of effort                                               |\n| [Generator Module](https://blackrock.industryswarm.com/docs/Server.Modules.Generator.html \"Generator Specification\")                      | Provides methods and command line tools to generate your own services for use within Blackrock                                                                                           |\n| [i18n Module](https://blackrock.industryswarm.com/docs/Server.Modules.i18n.html \"i18n Specification\")                                     | Provides support for internationalisation and localisation within your Blackrock services                                                                                                |\n| [Installer Module](https://blackrock.industryswarm.com/docs/Server.Modules.Installer.html \"Installer Specification\")                      | Allows you to install additional services in to your application server from the Blackrock marketplace                                                                                   |\n| [Jobs Module](https://blackrock.industryswarm.com/docs/Server.Modules.Jobs.html \"Jobs Specification\")                                     | Allows you to create, manage and execute asynchronous jobs (from your services) - recurring and scheduled                                                                                |\n| [Logger Module](https://blackrock.industryswarm.com/docs/Server.Modules.Logger.html \"Logger Specification\")                               | Provides a method (log) to log your service (or intra app server) events and distribute these to any one of a number of log sinks                                                        |\n| [Router Module](https://blackrock.industryswarm.com/docs/Server.Modules.Router.html \"Router Specification\")                               | Routes requests and responses between interfaces and service routes                                                                                                                      |\n| [Sandbox Module](https://blackrock.industryswarm.com/docs/Server.Modules.Sandbox.html \"Sandbox Specification\")                            | Provides a sandbox environment to execute un-trusted Javascript code within your application server                                                                                      |\n| [AppEngine Module](https://blackrock.industryswarm.com/docs/Server.Modules.AppEngine.html \"AppEngine Specification\")                         | Loads, manages and provides access to and between all apps running on your application server                                                                                        |\n| [Universe Module](https://blackrock.industryswarm.com/docs/Server.Modules.Universe.html \"Universe Specification\")                         | Provides the Universe object to your services, giving you access to a world of real-time data. Make your service environmentally reactive!                                               |\n| [Utilities Module](https://blackrock.industryswarm.com/docs/Server.Modules.Utilities.html \"Utilities Specification\")                      | Provides a collection of popular Utility methods that you can access within the application server (modules) or from your services                                                       |\n\n\n\n\u003cbr/\u003e\n\n### Interface Specifications\n\n*Below you can find the specifications for each Blackrock interface:*\n\n| Module                                                                                                                           | Description                                                                                          |\n| -----------                                                                                                                      | -----------------------------------------------------------------------------------------------------|\n| [Axon Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.Axon.html \"Axon Specification\")                       | Provides an interface for the Axon protocol                                                          |\n| [HTTP Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.HTTP.html \"HTTP Specification\")                       | Provides an interface for the HTTP and HTTPS protocol                                                |\n| [NanoMSG Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.NanoMSG.html \"NanoMSG Specification\")              | Provides an interface for the NanoMSG protocol                                                       |\n| [SSH Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.SSH.html \"SSH Specification\")                          | Provides an interface for the SSH protocol                                                           |\n| [WebSockets Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.WebSockets.html \"WebSockets Specification\")     | Provides an interface for the WebSockets protocol                                                    |\n| [ZeroMQ Interface](https://blackrock.industryswarm.com/docs/Server.Interfaces.ZeroMQ.html \"ZeroMQ Specification\")                 | Provides an interface for the ZeroMQ protocol                                                        |\n\n\u003cbr/\u003e\u003cbr/\u003e\n\n\n\n### Gratitude\n\nThanks for downloading the Blackrock Framework. We look forward to seeing what you build with it.\n\n\u003cbr/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findustryswarm%2Fblackrock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findustryswarm%2Fblackrock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findustryswarm%2Fblackrock/lists"}