thomaschaaf / actionhero

actionHero is a node.js API framework for tcp sockets, web sockets, and http clients. The goal of actionHero are to create an easy-to-use toolkit for making reusable, scalable APIs.

actionHero API Framework

Links: NPM | Wiki | API Methods | Public Site | GitHub | Mailing List | Client

Who is the actionHero?

actionHero is a node.js API framework for many types of clients. 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.

Currently actionHero supports:

• Web Clients: HTTP, HTTPS
• Socket Clients: TCP (telnet), TLS
• Web Socket (socket.io) clients: HTTP, HTTPS

actionHero is ideal for large game projects (MMOs), heavily trafficked APIs, and even API-driver websites. actionHero servers can process both requests and tasks (delayed actions like send e-mail or other background jobs). Taks can be enqued as a delayed job, or run periodically. actionHero servers can also run in a cluster (on the same or multiple machines) to work in concert to handle your load. Tasks can be alocated to run on any or all of the servers in yoru cluster.

Quick Start

npm install actionHero ./node_modules/.bin/actionHero generate ./node_modules/.bin/actionHero start

Want more?

• Getting Started
• Running actionHero
• Read the documentation on the wiki
• Check out the project 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