An open API service indexing awesome lists of open source software.

https://github.com/tomasbasham/blunderlist-comment-ts

Contrived todo app example comment service
https://github.com/tomasbasham/blunderlist-comment-ts

Last synced: 5 months ago
JSON representation

Contrived todo app example comment service

Awesome Lists containing this project

README

          

# blunderlist-comment-ts [![Build Status](https://travis-ci.com/tomasbasham/blunderlist-comment-ts.svg?branch=master)](https://travis-ci.com/tomasbasham/blunderlist-comment-ts) [![Maintainability](https://api.codeclimate.com/v1/badges/428e6cae5d8321a778ed/maintainability)](https://codeclimate.com/github/tomasbasham/blunderlist-comment-ts/maintainability)

A fictitious todo application through which to teach how to implement a
microservice architecture. For the full list of services required to run this
application visit
[Blunderlist](https://github.com/tomasbasham?utf8=✓&tab=repositories&q=blunderlist)
on GitHub.

This repository implements an comment API that manages the

## Prerequisites

You will need the following things properly installed on your computer.

* [Git](https://git-scm.com/)
* [Node](https://golang.org/)
* [TypeScript](https://www.typescriptlang.org/)
* [Docker](https://www.docker.com/)

## Installation

* `git clone ` this repository
* `cd blunderlist-comment-ts`
* `docker build -t comment-ts .`

## Running / Development

* `docker run --rm -it -p 8080:8080 --env-file .env comment-ts`
* Visit your app at [http://localhost:8080](http://localhost:8080).

### gRPC Health Check Service

Health check service for gRPC servers. Under the `src` directory is a
replacement for the Node.js [gRPC health check
service](https://github.com/grpc/grpc-node/tree/master/packages/grpc-health-check)
which is severely out of date. This has been built using the `protoc` tool from
the most recent `health.proto`
[definition](https://github.com/grpc/grpc/blob/be1ce0c4ccbf17ebeee9b7b057d40ff4e12f3479/src/proto/grpc/health/v1/health.proto).

## Further Reading / Useful Links

* [TypeScript](https://www.typescriptlang.org/)
* [gRPC](https://grpc.io/)
* [protobuf](https://developers.google.com/protocol-buffers/)