Kraken Framework Official Documentation

Description

This repository contains official documentation for Kraken Framework. We recommend you to read this pages on official website. If you see any problems or misleading parts of this document, tell use about it in Github Issues or consider making contributions yourself.

Table of Contents

• Introduction
  • About the Kraken
  • About the Documentation
  • Help & Support
• Getting Started
  • Installation
  • Directory Structure
  • Configuration
  • Bootstrap
  • Project Deployment
• Core Concepts
  • Asynchronity
  • Events & Event-Loop
  • Promises
  • Runtimes
  • Messaging
  • Supervision
• Bootstrap
  • Service Container
  • Service Providers
• CLI Support
  • Console Client
  • Console Server
• Common Patterns
  • Registering Providers
  • Registering Services
  • Adding Commands
  • Adding Runtime Listeners
• Components
  • Channel
  • Config
  • Container
  • Core
  • Event
  • Filesystem
  • Ipc
  • Log
  • Loop
  • Network
  • Promise
  • Runtime
  • Stream
  • SSH
  • Supervision
  • Throwable

Contributing

For contributions submitting documentation for the current stable release, submit it to the corresponding branch. For example, documentation for Kraken 0.3 should be submitted to the 0.3 branch. Documentation intended for the upcoming release should be submitted to the master branch.