README.md

[wip] pcbook

This is web service that will allow us to manage and search for laptop configurations

Services

The web service has the following services:

1. LaptopService

RPC	REQUEST TYPE	RESPONSE TYPE	DESCRIPTION
CreateLaptop	CreateLaptopRequest	CreateLaptopResponse	Creates and stores a new laptop
SearchLaptop	SearchLaptopRequest	SearchLaptopResponse	Searches for a laptop using the provided Filter
UploadImage	UploadImageRequest	UploadImageResponse	Uploads and stores a laptop image
RateLaptop	RateLaptopRequest	RateLaptopResponse	Rates a laptop

2. AuthService

RPC	REQUEST TYPE	RESPONSE TYPE	DESCRIPTION
Login	LoginRequest	LoginResponse	Attempts to login a user using the provided credentials

Generate TLS Certificates

To run the client and the server on TLS mode [enable-tls], you need to generate the certificates.

  make gen-cert

Running Servers

By default, all servers run with the enable-tls flag enabled.

To run the client, run the following command:

  make run-client

The app supports two types of servers:

• gRPC
• REST (HTTP) using GRPC Gateway

To run the gRPC server, run the following command:

  make run-grpc-server

To run the REST server, run the following command:

  make run-rest-server

Running Tests

To run tests, run the following command

  make test