Initial commit

.dockerignore

@@ -0,0 +1,3 @@
+vendor
+.git
+.gitignore

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: [gbrayhan] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: BossonH # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    vendor: true
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/go.yml

@@ -0,0 +1,28 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+
+    - name: Build
+      run: go build -v ./...
+
+    - name: Test
+      run: go test -v ./...

.gitignore

@@ -0,0 +1,12 @@
+# IDE Folders and Files
+.idea
+.DS_Store
+
+
+
+microservices
+config.json
+
+microservices-go
+
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,35 @@
+## Contributing Guidelines
+Thank you for considering contributing to our project. To ensure that all contributors have a positive experience, we have established some guidelines that you should follow.
+
+Before you begin contributing, make sure to read our Code of Conduct to understand how we expect community members to interact with each other.
+
+### How to Contribute.  
+1. Fork the repository on GitHub.
+2. Create a branch in your fork with a descriptive name indicating the change you are making.
+3. Make the changes in your branch.
+4. Make sure your changes follow clean architecture patterns and coding best practices in Go.
+5. Run tests to ensure you haven't introduced any errors.
+6. Create a pull request from your branch to the main branch of the repository.
+7. Wait for the team to review your pull request. If changes are needed, make sure to make them before submitting a new review.
+8. Once your pull request is approved, the team will merge it into the main branch.
+
+### How to Report an Issue.  
+
+If you find a bug or issue in the project, please follow these steps to report it:
+
+1. Open an issue on the repository describing the problem as detailed as possible.
+2. Provide an example of the incorrect behavior and how it can be reproduced.
+3. Provide information about the environment in which you are running the code, including the version of Go you are using.
+4. If you have a solution for the problem, please submit a pull request following the guidelines established above.
+
+### Pull Request Guidelines
+To ensure that pull requests integrate smoothly, please follow these guidelines:
+
+1. Follow the guidelines established in our Code of Conduct.
+2. Make sure your code follows Go's coding conventions, including formatting and style.
+3. Make sure your code follows clean architecture patterns and coding best practices in Go.
+4. Make sure your changes do not break any existing tests, and you have added tests for any new functionality.
+5. Create a detailed description of the changes you made and why you made them.
+
+
+Thank you for contributing to our project. Your time and effort are greatly appreciated.

Dockerfile

@@ -0,0 +1,13 @@
+FROM golang:1.20 AS builder
+WORKDIR /srv/go-app
+COPY . .
+RUN go build -o microservice
+
+
+FROM golang:1.20
+WORKDIR /srv/go-app
+COPY --from=builder /srv/go-app/config.json .
+COPY --from=builder /srv/go-app/archives ./archives/
+COPY --from=builder /srv/go-app/microservice .
+
+CMD ["./microservice"]

LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (ctx) 2020 [email protected]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,103 @@
+# Golang Microservices Boilerplate - Clean Architecture
+
+[![issues](https://img.shields.io/github/issues/gbrayhan/microservices-go)](https://github.com/gbrayhan/microservices-go/tree/master/.github/ISSUE_TEMPLATE)
+[![forks](https://img.shields.io/github/forks/gbrayhan/microservices-go)](https://github.com/gbrayhan/microservices-go/network/members)
+[![stars](https://img.shields.io/github/stars/gbrayhan/microservices-go)](https://github.com/gbrayhan/microservices-go/stargazers)
+[![license](https://img.shields.io/github/license/gbrayhan/microservices-go)](https://github.com/gbrayhan/microservices-go/tree/master/LICENSE)
+[![CodeFactor](https://www.codefactor.io/repository/github/gbrayhan/microservices-go/badge/main)](https://www.codefactor.io/repository/github/gbrayhan/microservices-go/overview/main)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6c10cc49928447f38952edaab67a94a4)](https://www.codacy.com/gh/gbrayhan/microservices-go/dashboard?utm_source=github.com&utm_medium=referral&utm_content=gbrayhan/microservices-go&utm_campaign=Badge_Grade)
+
+Example structure to start a microservices project with golang. Using a MySQL databaseSQL. Using a Hexagonal
+Architecture tha is a Clean Architecture.
+
+## Manual Installation
+
+If you would still prefer to do the installation manually, follow these steps:
+
+Clone the repo:
+
+```bash
+git clone https://github.com/gbrayhan/microservices-go
+```
+
+If you need, configure the environment variables in file config.json, if you use docker-compose leave the variables set
+in the file config.json.example
+
+```bash 
+cp config.json.example config.json
+```
+
+**TL;DR command list**
+
+    git clone https://github.com/gbrayhan/microservices-go
+    cd microservices-go
+    cp config.json.example config.json
+    docker-compose up  --build  -d
+
+## Table of Contents
+
+- [Features](#features)
+- [Commands](#commands)
+- [Environment Variables](#environment-variables)
+- [Project Structure](#project-structure)
+- [API Documentation](#api-documentation)
+- [Error Handling](#error-handling)
+- [Validation](#validation)
+- [Linting](#linting)
+
+## Features
+
+- **Golang v1.21**: Stable version of go
+- **Framework**: A stable version of [gin-go](https://github.com/gin-gonic/gin)
+- **Token Security**: with [JWT](https://jwt.io)
+- **SQL databaseSQL**: [MariaDB](https://mariadb.org/) using internal sql package of
+  go [sql](https://golang.org/pkg/databaseSQL/sql/)
+- **Testing**: unit and integration tests using package of go [testing](https://golang.org/pkg/testing/)
+- **API documentation**: with [swaggo](https://github.com/swaggo/swag) @latest version that is a go implementation
+  of [swagger](https://swagger.io/)
+- **Dependency management**: with [go modules](https://golang.org/ref/mod)
+- **Environment variables**: using [viper](https://github.com/spf13/viper)
+- **Docker support**
+- **Code quality**: with [CodeFactor](https://www.codefactor.io/) and [Codacy](https://www.codacy.com/)
+- **Linting**: with [golangci-lint](https://golangci-lint.run/usage/install/) an implementation of a Golang linter
+
+## Commands
+
+### Build and run image of docker
+
+```bash
+docker-compose up  --build  -d
+```
+
+### Swagger Implementation
+
+```bash
+swag init -g src/infrastructure/rest/routes/routes.go
+```
+
+To visualize the swagger documentation on local use
+
+http://localhost:8080/v1/swagger/index.html
+
+To see the postman collection use 
+
+https://www.postman.com/kts-mexico/workspace/boilerplategomicroservice
+
+
+### Unit test command
+
+```bash
+# run recursive test
+go test  ./test/unit/...
+# clean go test results in cache
+go clean -testcache
+```
+
+### Lint inspection of go
+
+```bash
+golangci-lint run ./...
+```
+
+
+