https://github.com/folkengine/rngo

https://github.com/folkengine/rngo

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/folkengine/rngo
• Owner: folkengine
• License: gpl-3.0
• Created: 2023-04-23T15:15:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-01T02:23:33.000Z (over 1 year ago)
• Last Synced: 2025-03-06T00:52:45.950Z (3 months ago)
• Language: Go
• Size: 53.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build and Test](https://github.com/devplaybooks/.baseline/actions/workflows/CI.yml/badge.svg)](https://github.com/folkengine/rngo/blob/main/.github/workflows/CI.yml)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/golang-standards/project-layout?style=flat-square)](https://goreportcard.com/report/github.com/folkengine/rngo)

---

## Dependencies

* [Ginkgo 2.0](https://github.com/onsi/ginkgo)

  * [Ginkgo 2.0 Migration Guide](https://github.com/onsi/ginkgo/blob/ver2/docs/MIGRATING_TO_V2.md)

* [Gomega, Ginkgo's Preferred Matcher Library](https://github.com/onsi/gomega)

## Includes

* [Base Template for Dev Playbook](https://github.com/devplaybooks/.baseline)

* GitHub Actions

  * [golangci-lint](https://github.com/golangci/golangci-lint-action)

    * [A Complete Guide to Linting Go Programs](https://freshman.tech/linting-golang/)

## Resources

* [Standard Go Project Layout](https://github.com/golang-standards/project-layout)

## Steps

* Initiate [go module](https://go.dev/doc/modules/gomod-ref).

```shell

go mod init github.com/folkengine/rngo

```

* Updated Build and Test badge

* Updated Go Report Card badge

* Created [/pkg](https://github.com/golang-standards/project-layout/tree/master/pkg) directory

* Added languages repo as git submodule: 

```shell

git submodule add https://github.com/electronicpanopticon/rng_languages.git pkg/languages

```

Added testing libraries

```shell

go get github.com/onsi/ginkgo/v2

go get github.com/onsi/gomega

```

Adding ginkgo universally

```shell

go install github.com/onsi/ginkgo/v2/ginkgo@latest

```

## Linting

* [golangci-lint](https://github.com/golangci/golangci-lint)

  * [Local installation](https://golangci-lint.run/usage/install/#local-installation)

## go:embed

* [How to embed files into Go binaries](https://stackoverflow.com/questions/17796043/how-to-embed-files-into-go-binaries)

  * [go:embed](https://pkg.go.dev/embed@master)