README.md

actionhero.js

The Reusable, Scalable, and Quick node.js API Server

---

NPM | Docs | Public Site | GitHub | Mailing List | Chat | Client

---

Who is the actionhero?

actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks. The goal of actionhero is to create an easy-to-use toolkit for making reusable & scalable APIs. Clients connected to an actionhero server can consume the api, consume static content, and communicate with each other. actionhero is cluster-ready, with built in support for background tasks, 0-downtime deploys, and more.

Currently actionhero supports:

• Web Clients: HTTP, HTTPS
• Socket Clients: TCP (telnet), TLS
• Web Socket Clients: HTTP, HTTPS

You can also make your own servers and transports.

Quick Start

# mkdir new_project; cd new_project
npm install actionhero
./node_modules/.bin/actionhero generate
npm start

Or spawn a web API server now:

Want more?

• Getting Started
• Running actionhero
• Read the documentation
• View the release history

Who?

• The primary creator of the actionhero framework is Evan Tahler, but many others have helped
• Logo by Ali Spagnola
• If you want to contribute to actionhero, contribute to the conversation on github