0.2.6 • Published 1 year ago

constru.floorplan.svc v0.2.6

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
1 year ago

Floorplan

A floorplan generator service.

Deploy to dev2

  • Merge changes to main branch.
  • Automatically update k8s repo with git sha.
  • Go to ArgoCD to sync the pending deployment.

Deploy to prod (Not in ArgoCD atm)

  • Assure to increase the version number to next one eg - (V0.0.5 -> V0.0.6).
  • Create a tag and push to main.
  • Automatically deployment will start to deploy the tag to prod env.

Run service locally

  • note: the deployed service is triggered by any object update on S3 on the models bucket from the constru.api. when runing locally, it is we that should trigger the floorplan generation per model.
  • npm install
  • create an .env file on root folder with the following (replace *** with relevent environment parameters)
AWS_PROFILE=***

CONSTRU_API_DOMAIN=***
MODELS_BUCKET_NAME=***
ASSETS_BUCKET=***

SLACK_NOTIFICATIONS_CHANNEL=#async-tasks-notifications-dev-test-channel
  • npm run dev
  • (NORMAL WORKFLOW, as triggered for every new model uploaded) - to generate SVG and Images for for floor and apartments, send a GET request to http://localhost:3080/?projectId=INSERTPROJECTID&floorId=INSERTFLOORID . you will get a response telling you the task has started. NOTE: you must have the relvent model on the S3 in order to generate the photos/SVG. SVGs will be saved under MODELS_BUCKET_NAME/floorPlansImages/PROJECTID, and JPGs will be saved under ASSETS_BUCKET/PROJECTID. If TSV import was nor performed for this floor, the task will generate the SVGs/JPGs but will fail on creating photo point plan on the database.