AIS-backend

Prerequisites

• Install Protobuf Compiler (protoc)
• Install Redis

Development

• npm i
• Copy .env.example to .env and fill out appropiate values
• Run npx prisma generate to create/update the prisma client class used in the code
• git submodule update --init --recursive to update submodules
• npm run build:protos:(mac/win) to generate TypeScript from .proto
• redis-server in a new terminal (use WSL on Windows) to start Redis server
• npm run dev

Prisma commands

• If connecting to new db run npx prisma migrate deploy to apply migration files
• If changes are made to schema.prisma
  • Run npx prisma migrate dev --name "{...}" to create and apply new migration file
  • Run npx prisma generate to create/update the prisma client class used in the code

Redis commands

• redis-server in a new terminal (use WSL on Windows) to start Redis server
• redis-cli to connect to Redis instance
  • shutdown to stop instance
  • flushdb to clean DB

Test

• npm run test
• npm run test:cov to show