The grpc-unary-pattern-reminder-service.practice from cristianino

grpc-unary-pattern-reminder-service.practice's Introduction

Certainly! Here's a basic README.md template for your gRPC unary pattern practice in Go:

# gRPC Unary Pattern Practice in Go

This repository contains a basic implementation of the gRPC unary pattern in Go, focusing on task management functionalities such as creating tasks with priority and tags, retrieving tasks, and formatting task details.

## Features

- **Create Tasks:** Users can create tasks by specifying a message, limit date, team name, priority, and optional tags.

- **Retrieve Tasks:** Users can retrieve tasks, and the details are formatted for easy readability.

- **Incremental Task IDs:** Tasks are assigned incremental IDs on the server side.

## Getting Started

### Prerequisites

- Go (1.16 or higher)
- Protocol Buffers compiler (`protoc`)

### Installation

1. Clone the repository:

   ```bash
   git clone https://github.com/cristianino/gRPC-unary-pattern-reminder-service.practice.git
   cd grpc-unary-pattern-practice

Generate Go code from the .proto file:

protoc --go_out=. --go_opt=paths=source_relative --go-grpc_out=. --go-grpc_opt=paths=source_relative protoService/service.proto

Run the server:
```
go run server/main.go
```
Run the client:
```
go run client/main.go
```

Usage

When prompted, choose the option to create a task and provide the required information.
Optionally, provide tags when creating a task.
Choose the option to retrieve tasks and view the formatted details.

Contributing

Contributions are welcome! Please follow the Contribution Guidelines.

License

This project is licensed under the MIT License.


This README template provides a brief overview of the project, instructions for getting started, and a section for contributing and licensing information. Feel free to customize it further based on your project's specific details and requirements.

Recommend Projects