README.md

Chrome Extension Backend

Serverless project for the backend functionality to the Offie Chrome extension.

Table of Contents

• Architecture
• Running locally
  • Install serverless
  • Install dependencies
  • Function invokation
    • Generate sample events
  • API emulation
• Testing
  • Debugging
• Secrets

Architecture

Running locally

Install serverless

yarn global serverless

Install dependencies

yarn

Function invokation

Invoke the listingsDetails function locally with the following command:

yarn listingsDetails

Recompile and run on source changes with the following command:

yarn listingsDetails:watch

Generate sample events

Generate a new aws:apiGateway event with the following command:

sls generate-event --type aws:apiGateway

API emulation

Run a mock API Gateway instance locally with the following command:

yarn local
open http://localhost:3000/details?listingId=39433994

Testing

Run tests with the following command:

yarn test

Code coverage reports can be viewed with the following 2 commands:

yarn test:coverage
yarn test:openCoverage

Debugging

Invoke the listingsDetails function in debug mode with the following command:

yarn listingsDetails:debug

Secrets

Secrets should be stored in our Github secrets.