dsgo

README

Example discord bot applying a layered architecture.

[!IMPORTANT] dsGO is still in the early stages of development.

Showcase

Usage (Demo)

[!NOTE]

• System Requirements
• In the Demo version, the link to confirm the account is sent through the Terminal.
  • "Hi <username>, please confirm your account through this link: <link>"
• You can define your own SMTP configuration in the .env.demo file by simply modifying the SERVER_SMTP_* variables, then you will receive the links by mail.

make demo

Features

Project Layout

• Based on Standard Go Project Layout.

Git

• Hooks managed by husky:
  • Pre-Push:
    • Scanning Repository for leaks using TruffleHog CLI and Trivy
  • Pre-Commit: lint-staged
    • Scanning files for leaks using TruffleHog CLI
    • Formatting
  • Commit-Msg: commitlint
    • Check Conventional Commits rules
• Commit message helper using Commitizen.
  • Interactive prompt that allows you to write commits following the Conventional Commits rules:

    make commit
    

Linting/Formatting Tools

• Go: staticcheck and gofmt.
• templ: templ fmt.
• Gherkin: Cucumber extension.
• Others: Prettier cli/extension.

Scanners

• TruffleHog CLI: Secrets.
• Trivy: Secrets, Vulnerabilities and Misconfigurations.
• OSV-Scanner: Vulnerabilities.

Testing Packages

• Random data generator: Gofakeit.
• Unit/Integration: Testify.
• Acceptance: Testify, Godog (Cucumber) and Playwright.

Releases

• Automatically managed by Release It!:
  • Before/After Hooks for:
    • Linting
    • Testing
  • Bump version based on Conventional Commits and SemVer:
    • CHANGELOG generator
    • Commits and Tags generator
    • GitHub Releases

GitHub

• Actions for:
  • Setup Languages and Dependencies
• Workflows running:
  • Automatically (Triggered by Push or Pull requests):
    • Secrets Scanning (TruffleHog Action)
    • Linting
    • Testing
  • Manually (Using the Actions tab on GitHub):
    • Upgrade Dependencies
    • Automate Release
• Issue Templates (Defaults).

Devcontainer

• Multiple Features already pre-configured:
  • Go
  • Node
  • Docker in Docker
• Extensions and their respective settings to work with:
  • Go
  • templ
  • Cucumber
    • Gherkin
  • Prettier
  • Better Comments
  • Todo Tree
  • cSpell

Docker

• Dockerfile
  • Multi-stage builds:
    • Development
    • Testing
    • Build
    • Production
• Compose
  • Switched by ENVs.

Message Broker

• Routing Key based on AsyncAPI Topic Definition.

Security

• Form validation at the client using Fomantic - Form Validation.
  • On the server, the validations are performed using the Value Objects defined in the Context.
• Data authentication via JWT managed by Session Cookies.
• Account confirmation via Mail or Terminal.
• Password hashing using Bcrypt.
• Requests Rate Limiting.
• Server log files.

Scripts

• syncenv
  • Synchronize all .env* files in the directory using an .env model.
• copydeps
  • Copies the files required by the browser dependencies from the node_modules folder and places them inside the static folder on the server.
• upgrade
  • Perform the following steps to upgrade the project:
    1. Upgrade Go and Node dependencies.
    2. Linting and Testing.
    3. Commit changes.
• run
  • Display the logs and redirect them to a file whose name depends on the time at which the service was run.
  • Used in Production Image.

Basic Workflow (Domain > (Infrastructure | Application) > Presentation)

Context (Domain, Infrastructure & Application) > (Modules)

• Domain
  • Value Objects
    • Mother Creators
    • Unit Tests
  • Messages (Event/Command)
    • Mother Creators
  • Aggregates
    • Aggregate Root
    • Mother Creators
  • Models (Ports)
    • Repository
    • Broker
• Infrastructure
  • Persistence
    • Repository Mocks
    • Adapters
    • Integration Tests
  • Communication
    • Broker Mocks
    • Adapters
    • Integration Tests
• Application
  • Commands
    • Mother Creators
  • Querys/Responses
    • Mother Creators
  • Handlers/Consumers
    • Inputs & Outputs
      • Uses Cases
    • Unit Tests

App (Presentation) > (Server)

• Presentation
  • Services (Modules)
  • Templates
  • Handlers
  • Routes
  • Features (Gherkin)
    • Acceptance Tests

First Steps

Clone

HTTPS

git clone https://github.com/bastean/dsgo.git && cd dsgo

SSH

git clone git@github.com:bastean/dsgo.git && cd dsgo

Initialize

Dev Container (recommended)

1. System Requirements

   • Docker

     • Dev Containers

2. Start VS Code

   code .
   

3. Open Command Palette

   • Ctrl+Shift+P

4. Run

   Dev Containers: Reopen in Container
   

Locally

1. System Requirements

   • Go
   • Node
   • Make
   • Docker

2. Run

   make init
   

ZIP

1. System Requirements

2. Run

   make init-zero
   

GitHub Repository

Settings

Actions

• General

  • Workflow permissions

    • Read and write permissions

Secrets and variables

• Actions

  • New repository secret

    • BOT_GPG_PRIVATE_KEY

      gpg --armor --export-secret-key [Pub_Key_ID (*-BOT)]
      

    • BOT_GPG_PASSPHRASE

Run

ENVs

[!IMPORTANT] Before running it, you must set the following environment variables and rename the file to .env.(dev|test|prod).

• .env.example

[!TIP] You can check the demo file to see which values you can use.

• .env.example.demo

Development

make compose-dev

Tests

Unit

make test-unit

Integration

make compose-test-integration

Acceptance

make compose-test-acceptance

Unit/Integration/Acceptance

make compose-tests

Production

make compose-prod

Tech Stack

Base

• Go
• templ
  • Fomantic-UI
• RabbitMQ
• MongoDB

Please see

• go.mod
• package.json

Contributing

• Contributions and Feedback are always welcome!
  • Open a new issue

License

• MIT