README.md

ActionHero

The reusable, scalable, and quick node.js API server for stateless and stateful applications

NPM | Web Site | Latest Docs | GitHub | Slack | Twitter

ActionHero v18

ActionHero v18 is the async/await Node.js framework you have been waiting for!

ActionHero version 18 has many significant and breaking changes from previous versions. Please read the Release notes and Upgrade Guide

Who is the ActionHero?

ActionHero 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 for HTTP, WebSockets, and more. 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. ActionHero provides a simple Async/Await API for managing every type of connection and background task.

Currently actionhero supports the following out of the box...

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

... and you can also make your own servers and transports.

Quick Start

# mkdir new_project; cd new_project
npm install actionhero
npx actionhero generate
npm start

Your new project will come with example actions, tests, and more.

Or deploy a free API server now:

Learn More 📚

• Getting Started @ www.actionherojs.com
  • ActionHero's marketing site can be found @ https://github.com/actionhero/www.actionherojs.com/. If you want to contribute to this site, visit the related project
• Read the documentation @ docs.actionherojs.com
  • Starting with ActionHero version 18, the documentation for each version is included in this repository (and the NPM package) in the /docs folder. The current version of this documentation is also automatically deployed to https://docs.actionherojs.com.
• Find community-based resources
• Interact with the Community & View the Release History
• Server Client

In-depth Tutorials 🎓

Core Components

• Actions
• Tasks
• Middleware
• Initializers
• CLI Commands
• Configuration
• Cluster
• Chat & Realtime Communication
• File Server
• Logging
• Plugins
• Servers
• Localization & Translation

Server Types

• Web Server & Routes
• Socket Server
• WebSocket Server

Testing, Deployment, and Operations

• Running ActionHero
• Development Mode & REPL
• Testing & SpecHelper
• Production Notes
• Upgrade Path

Sample Projects

• Simple
• Elaborate (Angular, Sequelize)
• Client Use: React
• Client Use: React Native

Who?

• Many folks have helped to make ActionHero a reality.
• If you want to contribute to actionhero, contribute to the conversation on github and join us on slack