MAPS Data Access API

API for accessing data
API . OpenAPI explorer . Report Bug · Request Feature

This application is generated using LoopBack 4 CLI with the initial project layout.

Set up the database

See the database repository on how to set up a database for the MAPS project.

Install dependencies

By default, dependencies were installed when this application was generated. Whenever dependencies in package.json are changed, run the following command:

npm install

To only install resolved dependencies in package-lock.json:

npm ci

Set up environment variables

• copy .env.example to .env
• fill in the various variables (descriptions of what the variables are is in the file). Make sure never to commit the .env file itself, as it will contain sensitive information such as passwords.

Run the application

npm start

You can also run node . to skip the build step.

Open http://127.0.0.1:3000 in your browser.

Rebuild the project

To incrementally build the project:

npm run build

To force a full build by cleaning up cached artifacts:

npm run clean
npm run build

Fix code style and formatting issues

If eslint and prettier are enabled for this project, you can use the following commands to check code style and formatting issues.

npm run lint

To automatically fix such issues:

npm run lint:fix

Other useful commands

• npm run migrate: Migrate database schemas for models
• npm run openapi-spec: Generate OpenAPI spec into a file
• npm run docker:build: Build a Docker image for this application
• npm run docker:run: Run this application inside a Docker container

Tests

npm test

Versioning

The API is automatically versioned using semvar versioning based on commit message history (https://www.conventionalcommits.org/en/v1.0.0/)

What's next

Please check out LoopBack 4 documentation to understand how you can continue to add features to this application.