Question 1

How to add a new feature module in node-api-boilerplate?

Accepted Answer

Use the makeModule function from the context, define dependencies and lifecycle hooks in the module constructor, and register it in the bootstrap process, as explained in the module internals section.

Question 2

Node-api-boilerplate vs Express: which is better for building APIs?

Accepted Answer

This boilerplate provides a structured architecture with DDD and dependency injection for long-term maintainability, while Express is a minimalist framework for flexibility; choose based on need for architectural rigor vs simplicity.

Question 3

Can I use SQL databases with this boilerplate?

Accepted Answer

Yes, but you need to create a custom module for SQL integration, as the example uses MongoDB but the boilerplate is database-agnostic, requiring manual implementation of repositories.

Question 4

How to run the application in production mode?

Accepted Answer

Build the app with yarn build, define environment variables, and start it with yarn start, following the steps in the 'Going to production' section of the README.

Question 5

What are the lifecycle events and how do I use them?

Accepted Answer

Lifecycle events include Booting, Booted, Ready, Running, Disposing, Disposed; modules can hook into them using app.onEventName(callback) in the constructor, as detailed in the lifecycle events section.

Question 6

Is Docker required to use node-api-boilerplate?

Accepted Answer

No, Docker is optional but included for containerized development; you can run commands directly with yarn, though the wrapper simplifies environment management.

Node API Boilerplate

What is Node API Boilerplate?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions