Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
actionhero.js is a multi-transport nodejs API Server with integrated cluster capabilities and delayed tasks
JavaScript HTML

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
actions
certs
examples
helpers
initializers
public
scripts
tasks
test
.gitignore
.travis.yml
api.js
config.js
license.txt
package.json
readme.md
routes.js
versions.md

readme.md

actionHero API Framework

Build Status

Links: NPM | Wiki | Public Site | GitHub | Client

Who is the actionHero?

actionHero is a node.js API framework for both tcp sockets, web sockets, and http clients. The goal of actionHero are 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 servers can process both requests and tasks (delayed actions like send e-mail or other background jobs). actionHero servers can also run in a cluster (on the same or multiple machines) to work in concert to handle your load.

The actionHero API defines a single access point and accepts GET, POST, PUT and DELETE input along with persistent connection via TCP or web sockets. You define Actions which handle input and response, such as "userAdd" or "geoLocate". HTTP, HTTPS, and TCP clients can all use these actions. The actionHero API is not inherently "RESTful" (which is meaningless for persistent socket connections) but can be extended to be so if you wish.

actionHero will also serve static files for you, but actionHero is not meant to be a 'rendering' server (like express or rails).

Quick Start

mkdir ~/my-action-hero-project && cd ~/my-action-hero-project
npm install actionHero
npm run-script actionHero generate
npm start

Want more?

Who?

  • The primary creator of the actionHero framework is Evan Tahler
  • Logo by Ali Spagnola
  • If you want to contribute to actionHero, contribute to the conversation on github
Something went wrong with that request. Please try again.