cloudcms-internal-api

Lambda for our internal apis available to use with CloudCMS

Setup

• Install lerna globally if you haven't already: npm install -g lerna

• Copy env-template to .env

• Populate the variables within .env with the needed values

• Install dependencies: lerna bootstrap

Running

Starting the service

To transpile the source and start the service, run yarn build && yarn start

Start and watch for changes

• To transpile the source, start the service and watch for any changes: yarn watch

NOTE: At the time of writing this there is an occasional issue with the watch script. If you run into that, you can run the build and run scripts. Alternatively, and preferably, you can fix the watch issue :trollface:

Watch additional packages within the lerna repo and restart

• To trigger a restart of cloudcms-api-proxy when changes are made within other packages within this lerna repo, add it's lib/ or dist/ directory to the "watch" array within nodemon.json. Then run lerna run watch

Debugging

To run in debug mode, you can start the application with serverless offline like this

node --inspect-brk ../../node_modules/serverless/bin/serverless.js offline

Then follow these instructions for opening chrome dev tools for debugging the application

Supported endpoints

To see all supported endpoints, please reference the functions section in serverless.yml

To view the source for one of those functions/endpoints, you can check the handler value, and then look for that file within the src directory instead of lib directory