https://github.com/j4ng5y/hnsecrets

https://github.com/j4ng5y/hnsecrets

Last synced: 14 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/j4ng5y/hnsecrets
• Owner: j4ng5y
• Created: 2021-02-13T20:39:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-16T03:26:42.000Z (almost 4 years ago)
• Last Synced: 2023-03-21T20:33:42.761Z (almost 2 years ago)
• Language: Go
• Size: 43 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HNSECRETS

## Development Prereqs

* Go: The language this app is written in  - https://golang.org/dl

    * Git is a requirement of Go (to use `go get`)

* Protoc: The Protocol Buffers compiler - https://github.com/protocolbuffers/protobuf/releases/latest

    * Install the grpc tooling: `go get google.golang.org/protobuf/cmd/protoc-gen-go google.golang.org/grpc/cmd/protoc-gen-go-grpc`

* make: The build tool to build this app

    * debian based systems: `apt-get install -y make`

    * rhel based systems: `yum install -y make` or `dnf install -y make`

    * macos: `brew install make`

    * windows: :shrug: - chocolatty maybe?

* docker/moby-engine/podman/etc...: A container runtime

## Building

To build this project, perform the following:

**Building/Running Locally**

1. clone this repository

2. `cd hnsecrets`

3. `make && make run`

This set of commands will generate the API code, test all the code, and build the binaries locally (in the respetive `svcs//bin` directory) and then runs the binaries for local testing.

**Building/Deploying Containers**

1. clone this repository

2. `cd hnsecrets`

3. `docker login`

4. `make test && make build && make deploy`

This set of commands will generate the API code, test all the code, build the containers, and deploy the containers to the `j4ng5y/hnsecrets` dockerhub repository.

**Checking test coverage**

To check the current test coverage, simply run `make test && make coverage`. This will open the HTML test coverage reports for both services.