Awesome Open Source
Awesome Open Source

🚂 generator-express-no-stress

Codacy Badge All Contributors

Create awesome Express.js applications with best of breed tech including via Babel.js, structured logging with Pino, API validation and interactive documentation using an OpenAPI 3 or Swagger 2 spec, environment based config with dotenv, and linting with ESLint.

GitHub stars Twitter URL

generator-express-no-stress gets you up and running in seconds. It's ridiculously easy to configure. Heck, just take the defaults. Start it. Write code.

This generator scaffolds a fully functioning REST API server, complete with interactive documentation, API request and response validation, structured logging, environment driven config, and more. Simply run the generator and smile :-D

Here's what you get!


Requires Node 8 or greater

npm install -g yo generator-express-no-stress
  • See here for use with Yarn and/or Docker
  • See here for Node 6 support


yo express-no-stress myapp
cd myapp


Run in development mode:

npm run dev

Package and run in production mode

npm run compile
npm start


npm test


Run one of the following, then attach your favorite inspector e.g. VSCode:

# debug the server
npm run dev:debug

# debug the tests
npm run test:debug

Try it!

Usage: CLI

yo express-no-stress [appname] [--yarn] [--docker]
Option default Description
appname myapp The application folder
--yarn - Use the yarn package manager, instead of npm
--docker Install Docker artifacts including a Dockerfile

Usage: Project

The sections below describe all usage options available once the project is generated/scaffolded.

npm targets

Target Description
npm run dev Run in development mode
npm run dev:debug Debug in development mode
npm run test Run tests
npm run test:debug Debug tests
npm run lint View a listing of all errors discovered by the linter
npm run lint:fix Fix all errors discovered by the linter
npm run compile Transpile source code for production use
npm start Run the in production mode. *Requires running npm run compile first

Debug in VSCode

Add these contents to your .vscode/launch.json file

Debug in WebStorm

  1. Start debug in development mode via npm run dev:debug
  2. From the "Run" menu, select "Debug"
  3. Select "Edit Configurations..."
  4. From the list of Templates on the left side of the dialog, select "Attach to Node.js/Chrome"
  5. Press the "Debug" button to attach the WebStorm debugger

Deploy to the Cloud

e.g. CloudFoundry

cf push myapp

Use Yarn

# scaffold
yo express-no-stress myapp --yarn
cd myapp

# run in development mode
yarn run dev

# run in production mode
yarn run compile
yarn start

# test
yarn test

What you get!

  • Express.js - Fast, unopinionated , minimalist web framework for Node.js

  • Babel.js - Use new syntax, right now without waiting for support

  • Pino - Extremely fast node.js logger, inspired by Bunyan. It also includes a shell utility to pretty-print its log files

  • dotenv - Loads environment variables from .env for nodejs projects

  • ESLint - a pluggable linting utility for JavaScript and JSX

    Choose from the following ESLint lint rules:

    • Airbnb - A mostly reasonable approach to JavaScript
    • Prettier - Prettier is an opinionated code formatter
  • Swagger - is a simple yet powerful representation of your RESTful API

  • SwaggerUI - dynamically generate beautiful documentation and sandbox from a Swagger-compliant API

API Validation

Simply describe your APIs with Swagger and automagically get for free:

  • Interactive documentation
  • API request validation
  • API response validation (OpenAPI 3 only. Disabled by default)
    • To enable set OPENAPI_ENABLE_RESPONSE_VALIDATION=true in .env

Interactive API Doc

API Validation!

Oops! I the API caller forgot to pass a name field, no stress, we've got this!

Structured Logging

Structured logging out of the box!



Structured logging pretty printed by default - great for dev!

API Validation Example

Simply describe your APIs with Swagger and automatically get:

  • API request validation
  • Interactive documentation


Swagger API spec

swagger: '2.0'
  version: 1.0.0
  title: myapp
  description: My cool app
basePath: /api/v1
  - name: Examples
    description: Simple example endpoints
  - name: Specification
    description: The swagger API specification

  - application/json
  - application/json

    type: object
    title: example
      - name
        type: string
        example: no_stress

        - Examples
      description: Fetch all examples
          description: Returns all examples
        - Examples
      description: Create a new example
        - name: example
          in: body
          description: an example
          required: true
            $ref: '#/definitions/ExampleBody'
          description: Returns all examples

        - Examples
        - name: id
          in: path
          required: true
          description: The id of the example to retrieve
          type: integer
          description: Return the example with the specified id
          description: Example not found

        - Specification
          description: Return the API specification

Invoke a POST request via the Interactive doc


express-no-stress uses ESLint and provides two choices, Airbnb or Prettier.

To add your own ESLint customizations, edit.eslintrc.json.

Note that the Airbnb variant provides a slightly modified Airbnb base configuration.


Q: How do I modify the example API and make it my own?

A: There are two key files that enable you to customize and describe your API:

  1. server/routes.js - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
  2. server/common/api.yaml - This file contains your OpenAPI spec. Describe your API here. It's recommended that you to declare any and all validation logic in this YAML. express-no-stress-typescript uses express-openapi-validator to automatically handle all API validation based on what you've defined in the spec.

Q: I previously generated an app, but I want to change the API root. How do I do this?

A: You need to make to small changes

  1. Modify server/routes.js
   // Change your original path e.g. /api/v1/examples, to:
   app.use('/api/v2/examples', examplesRouter);
  1. Modify server/common/api.yaml and update the api root:
  # Change e.g. /api/v1 to /api/v2
  - url: /api/v2   



Buy Me A Coffee

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jaime Leonardo Suncin Cruz


Daniel Bornstrand


Jason Corns


Frank Calise


Daisuke Tsuji


Sangbeom Han


Mike Lay




This project follows the all-contributors specification. Contributions of any kind welcome!

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (67,440) 
express (466) 
swagger (346) 
babel (336) 
openapi (194) 
expressjs (189) 
openapi3 (78) 
scaffold (67) 
yeoman-generator (44) 
express-js (29) 
structured-logging (21) 

Find Open Source By Browsing 7,000 Topics Across 59 Categories

Advertising 📦 10
All Projects
Application Programming Interfaces 📦 124
Applications 📦 192
Artificial Intelligence 📦 78
Blockchain 📦 73
Build Tools 📦 113
Cloud Computing 📦 80
Code Quality 📦 28
Collaboration 📦 32
Command Line Interface 📦 49
Community 📦 83
Companies 📦 60
Compilers 📦 63
Computer Science 📦 80
Configuration Management 📦 42
Content Management 📦 175
Control Flow 📦 213
Data Formats 📦 78
Data Processing 📦 276
Data Storage 📦 135
Economics 📦 64
Frameworks 📦 215
Games 📦 129
Graphics 📦 110
Hardware 📦 152
Integrated Development Environments 📦 49
Learning Resources 📦 166
Legal 📦 29
Libraries 📦 129
Lists Of Projects 📦 22
Machine Learning 📦 347
Mapping 📦 64
Marketing 📦 15
Mathematics 📦 55
Media 📦 239
Messaging 📦 98
Networking 📦 315
Operating Systems 📦 89
Operations 📦 121
Package Managers 📦 55
Programming Languages 📦 245
Runtime Environments 📦 100
Science 📦 42
Security 📦 396
Social Media 📦 27
Software Architecture 📦 72
Software Development 📦 72
Software Performance 📦 58
Software Quality 📦 133
Text Editors 📦 49
Text Processing 📦 136
User Interface 📦 330
User Interface Components 📦 514
Version Control 📦 30
Virtualization 📦 71
Web Browsers 📦 42
Web Servers 📦 26
Web User Interface 📦 210