Actionhero

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

**[NPM](https://npmjs.org/package/actionhero) | [Web Site](https://www.actionherojs.com) | [Latest Docs](https://docs.actionherojs.com) | [GitHub](https://github.com/actionhero/actionhero) | [Slack](https://slack.actionherojs.com) | [Twitter](https://twitter.com/actionherojs)**

[![NPM Version](https://img.shields.io/npm/v/actionhero.svg?style=flat-square)](https://www.npmjs.com/package/actionhero) [![Node Version](https://img.shields.io/node/v/actionhero.svg?style=flat-square)](https://npmjs.org/package/actionhero) [![NPM](https://img.shields.io/npm/dm/actionhero.svg?style=flat-square)](https://npmjs.org/package/actionhero) [![Dependency Status](https://david-dm.org/actionhero/actionhero.svg?style=flat-square)](https://david-dm.org/actionhero/actionhero) ![Test](https://github.com/actionhero/actionhero/workflows/Test/badge.svg) [![Chat](https://slack.actionherojs.com/badge.svg)](http://slack.actionherojs.com)

Quick Start

# Generate a new Project
npx actionhero generate
npm install
npm run build
npm run dev # <-- I automatically notice changes and restart, as well as compiling .ts files

# Use the actionhero CLI
(npx) actionhero generate action --name my_action
(npx) actionhero generate task --name my_task --queue default --frequency 0

# Test
npm test

# To deploy your app
npm run build
npm run 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 website can be found @ https://github.com/actionhero/www.actionherojs.com/. If you want to contribute to this site, visit the related project
- —> Start with the Tutorials <—
Read the typedoc 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

Server Types

Testing, Deployment, and Operations

Sample Projects

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

Thank you to all of Actionhero’s contributors!

image of contributors

Dedication

Technology is a powerful force in our society. Data, software, and communication can be used for bad: to entrench unfair power structures, to undermine human rights, and to protect vested interests. But they can also be used for good: to make underrepresented people’s voices heard, to create opportunities for everyone, and to avert disasters. This project is dedicated to everyone working toward the good.

Inspired by Martin Kleppmann

ActionHero