Features

• Project Layout

  • Based on Standard Go Project Layout

• Message Broker

  • Routing Key (based on AsyncAPI Topic Definition)

• Devcontainer

  • Features
  • Extensions & Settings

• Docker

  • Dockerfile
    • Multistage
  • Compose
    • Setup by ENV

• GitHub

  • Actions & Workflows
    • Setup Languages and Dependencies
    • Secrets Scanning (TruffleHog Action), Linting & Test Checks
    • Upgrade Dependencies
    • Automate Release
  • Issue Templates (Defaults)

• Git

  • Hooks
    • Pre-Commit
      • Secrets Scanning (TruffleHog CLI) & Formatting
    • Commit-Msg
      • Check Conventional Commits rules

• Releases

  • Automatically
    • Hooks
      • Linting & Test Checks
    • Bump Version (based on Conventional Commits & SemVer)
    • CHANGELOG
    • Commit & Tag
    • GitHub Release

• Security

  • Account confirmation via email
  • Password hashing (Bcrypt)

• Scripts

  • sync-env
    • Synchronize all .env* files in the directory using an .env model
  • upgrade
    1. Upgrade Go and Node dependencies
    2. Linting and Testing
    3. Commit changes

First Steps

Clone

HTTPS

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

SSH

git clone [email protected]:bastean/codexgo.git && cd codexgo

Initialize

Dev Container (recommended)

1. Install required

   • Docker

     • Dev Containers

2. Start VS Code

   code .
   

3. Open Command Palette

   • Ctrl+Shift+P

4. Run

   Dev Containers: Reopen in Container
   

Locally

1. Install required

   • Go
   • Node
   • Make
   • Docker

2. Run

   make init
   

ZIP

1. Install required

2. Run

   make from-zero
   

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

Test

• Unit

  make test-unit
  

• Integration

  make compose-test-integration
  

• Acceptance

  make compose-test-acceptance
  

• All

  make compose-test-all
  

Production

make compose-prod

Screenshots

Tech Stack

Base

• Go
• templ
  • htmx
  • Alpine.js
  • Tailwind CSS
    • daisyUI
• MongoDB
• RabbitMQ

Please see

• go.mod
• package.json

Contributing

• Contributions and Feedback are always welcome!

License

• MIT