seneca

(★ 3,959)

A microservices toolkit for Node.js.

File Explorer

  • .coveralls.yml
  • .eslintrc.js
  • .gitignore
  • .npmignore
  • .prettierrc
  • CHANGES.md
  • CODE_OF_CONDUCT.md
  • DEV.md
  • LICENSE
  • package.json
  • README.md
  • seneca.d.ts
  • seneca.js
  • seneca.js.map
  • seneca.ts
  • tsconfig.json

# Installation Guide

node
Prerequisites

Setup Steps

npm install

Install project dependencies.

node microservice.js

Run the microservice application.

Key Commands

npm install seneca

Install the Seneca library as a dependency.

npm run annotate

Generate annotated documentation in the docs folder.

Use the --seneca.test flag to run in test mode with full debug logs.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

node

View Details ▼

Server-side JavaScript platform (Node.js).

node {{path/to/file}}

Run a JavaScript file:

node

Start a REPL (interactive shell):

node --watch {{path/to/file}}

Execute the specified file restarting the process when an imported file is changed (requires Node.js version 18.11+):

🔍

npm install

View Details ▼

Install Node packages.

npm {{[i|install]}}

Install dependencies listed in `package.json`:

npm {{[i|install]}} {{package_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}

Download the latest version of a package and add it to the list of dev dependencies in `package.json`:

🔍

npm run

View Details ▼

Run a script.

npm run

List available scripts:

npm run {{script_name}}

Run a script:

npm run {{script_name}} -- {{argument}} {{--option}}

Pass arguments to a script:

# Project Badges

// repository documentation