ProductPromotion
Logo

Go.Lang

made by https://0x3d.site

GitHub - octomation/go-module: 🧩 Template for a typical module written on Go.
🧩 Template for a typical module written on Go. Contribute to octomation/go-module development by creating an account on GitHub.
Visit Site

GitHub - octomation/go-module: 🧩 Template for a typical module written on Go.

GitHub - octomation/go-module: 🧩 Template for a typical module written on Go.

Go Module

Coverage Quality Documentation CI/CD Promo Mirror Template

🧩 Module awesome.icon

Template for a typical module written on Go.

🛫 Quick start

$ make setup
$ make help

$ make find-todos
$ make test lint
$ TIMEOUT=5s make test-with-coverage

For more details please visit the page.

$ alias run=./Taskfile
$ run refresh
$ run help

$ run docs # === `run docs install -- build -- start`
$ run docs npm ci
$ run docs npm i nextra@latest

$ run tools go generate tools.go
$ run tools golangci-lint --version -- mockgen --version
$ run which goimports golangci-lint govulncheck mockgen

For more details please visit the page.

$ make tools
$ source bin/activate

$ which goimports
$ goimports -local $(go list -m) -w ./...

For more details please visit the page.

$ make go-1.11 # or go-1.12, etc.
/src# make go-env 2>/dev/null | grep GOVERSION
# GOVERSION:   1.11.13
/src# make test

💡 Idea

Define a powerful template that quickly creates a new Go module. Not only does it provide a starting point for new projects, but it comes equipped with pre-configured ci/cd and inventory.

🏆 Motivation

At OctoLab, we want to start new projects faster using best practices with a predefined structure and focusing on core ideas implementation rather than wasting time on environment configuration and copying boilerplate code.

🤼‍ How to

Build your own module

  1. Generate a new repository from the template.
  2. Clone the repository locally.
  3. Update the desired files as needed, e.g., run init my.new/module.
  4. Write your code and tests.
  5. 🚀

Contribute to the template

  1. Read the contribution guidelines.
  2. Fork the repository.
  3. Make your changes.
  4. Send a pull request.
  5. 🤗

Before you start, please make sure your changes are in demand. The best for that is to create a new discussion, or if you find an issue, report it first.

🎛️ Configuration

Pre-configured

  1. GitHub Actions.
  2. GitHub Pages.
  3. Dependabot.

Included

  1. Nextra.
  2. Makefiles.
  3. Taskfiles.
  4. Go tools: mockgen, golangci-lint, goimports, govulncheck.

Optional

  1. Bitbucket1.
  2. Cloudflare Pages2.
  3. Codecov.
  4. GitHub Socialify.
  5. Go Report Card.
  6. Settings3.
  7. Shields.io.
  8. Slack.
  9. Vanity URL.

Coming soon

  1. CodeQL (code scanning).
  2. Graphite (git workflow).
  3. Qodana (code quality).
  4. SonarCloud (code quality).
  5. Vercel (docs preview).

🛬 Integration

The project uses SemVer for versioning, and it is not BC-safe through major releases. Please use Go Modules to manage its version.

$ go get go.octolab.org@latest

🏗️ Ecosystem

Input

Impact

Output

Footnotes

  1. An alternative for backup could be GitLab, Gogs, or Gitea.

  2. Useful for private repositories.

  3. It has been deprecated and will be replaced someday by GitHub Actions.

Articles
to learn more about the golang concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here 🔥.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here 🔥.

Queries
or most google FAQ's about GoLang.

mail [email protected] to add more queries here 🔍.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory