DineSmart Retrieval Service

Overview

The DineSmart Retrieval Service is responsible for exposing an underlying Cloud Firestore database that contains inspection data.

Running the application locally

Create a Google Cloud IAM Principal with the Firebase Admin, Firebase Admin SDK Administrator Service Agent, and Firebase Service Agent Roles
Remove .template from .env.template and populate the file with the values from the service account JSON file
- The .env file is only used for local testing. On deployment, the required env variables should be injected by Render
Run the application using npm run start

Interacting with the API

You can interact with the API using Postman.

Technologies

Render
Cloud Firestore
Node.js (with TypeScript)
Sentry: Used for error monitoring and profiling

Related Projects

dinesmart: iOS Client
dinesmart-update-service: Firebase Cloud Function that populates the Cloud Firestore Database