Skip to content

Latest commit

 

History

History
81 lines (50 loc) · 2.7 KB

README.md

File metadata and controls

81 lines (50 loc) · 2.7 KB
Raw

License [Lifecycle:Maturing]

Forest Operation Map (FOM) API - Backend

Technical Details

Technology Stack: Node.js with Nest/TypeORM framework, PostgresSQL with PostGIS for database and migrations.

Documentation

Local Development

Once set up, the stack can be access using the following paths on localhost:

  • API: localhost:3333/api

Docker Compose

Local / Bare Metal

Run 'cd ../libs && npm ci' first.

Run 'npm install' for this component.

Start commands are available in package.json.

OBJECT_STORAGE_SECRET = object storage secret, available in the OpenShift dev secret fom-object-storage-dev

Here's how to run only the api locally:

# Source local variables
source ./localdev.env      # Linux, MacOS

# Object storage secret
export OBJECT_STORAGE_SECRET=<hidden>

# Make sure 'libs' dependencies is installed
cd ../libs && npm ci

# Install node modules
npm i

# Build and run the api
npm run start:api

Client Library Generation

These are the steps to generate the client library used by the frontend components (Admin + Public)

  • Code changes to the API that are documented in Swagger using Swagger annotations like @ApiTags, @ApiProperty
  • Start the API component (npm run start:api) and access http://localhost:3333/api-json. Copy this content to 'openapi/swagger-spec.json'
  • Remove the existing generated client library files. Delete the directories ../libs/client/typescript-ng/{api|models}.
  • Generate the client library using 'npm run gen:client-api:ng'. Generated files will be placed into '../libs/client/typescript-ng'
  • Copy the client library into the Admin and Public components in /src/core/api (current frontend has tsconfig.json 'path' referencing to this generated client so there is no need for this step; If it is not setup, then this step is required.)

Database Migrations Setup

License

Copyright 2021 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.