Skip to content

Latest commit

 

History

History
 
 

backend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
.env
.env
 
 
README.md
README.md
 
 
db.sqlite
db.sqlite
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 
yarn.lock
yarn.lock
 
 

README.md

Backend API to store Notes

Features

  • Typescript with gRPC support!
  • Requires Envoy proxy with Grpc Web plugin, for communication with frontend.
  • Uses Postgres Driver (in case DB's creds env are not provided, uses Sqlite3) to persistently store the notes.

Env Vars

Refer to k8s manifests for list of envs. For local run, it also requires PROTO_PATH env (check .env file for sample) which is a path (relative/absolute) to protos folder.

How to run?

  1. Make sure to first generate the protoc files for backend code (one time activity):
bash ../proto-gen.sh
  1. Build and run the code (hot-reload not supported):
yarn build
node dist/server.js

API Contract

Refer to NoteService for API contract.