Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
image
templates/scaffold
README.md
stack.yaml

README.md

Node.js LoopBack Stack

The Node.js LoopBack stack extends the Node.js stack and provides a powerful solution to build open APIs and Microservices in TypeScript with LoopBack, an open source Node.js API framework. It is based on LoopBack 4.

Image

The image contains the main code that loads the user application and configures with cloud native components such as @loopback/extension-health which exposes /health endpoint for health checks including with /ready for readiness and /live for liveness checks.

The project layout is structured as follows:

/project/ (main)
  package.json
  src/
    index.ts (importing user-app)
  dist/ (transpiled js code)
  ...
  user-app/ (code from the nodejs-loopback/templates/scaffold)
    package.json
    ...

Templates

Getting Started

  1. Create a new folder in your local directory and initialize it using the Appsody CLI, e.g.:

    mkdir my-project
    cd my-project
    appsody init nodejs-loopback

    This will initialize a Node.js LoopBack project using the default template.

  2. After your project has been initialized you can then run your application using the following command:

    appsody run

    This launches a Docker container that continuously re-builds and re-runs your project, exposing it on port 3000.

    You should now be able to access the following endpoints, as they are exposed by your application by default:

    You can continue to edit the application in your preferred IDE (VSCode or others) and your changes will be reflected in the running container within a few seconds.

See https://appsody.dev/docs/stacks/modify for more details.

License

This stack is licensed under the Apache 2.0 license

You can’t perform that action at this time.