Scout Me

A sibling project to zoubun, this is a project where the primary motivation is to get comfortable with the go ecosystem.

In this case, the goal is to create a hypermedia driven microblog/portfolio application that sends me emails with exactly the information that I can about when being scouted.

For speed, the project's structure was created using the go-blueprint tool.

Stack

• Frontend: Alpine.js (UI interactivity) + HTMX (backend interactivity)
• Styling: Tailwind + Pines (components) + picocss classless (base)
• Backend: Golang + Temple

Goals

• Configure HTMX, TailwindCSS, Golang and Templ to create a reasonably presentable landing page.
• Using a flowing form, send me a well formatted email notifying me of a potential position.
• Small profile section to list out skills that may match your needs (basically a copy jacobsky)
• Add internationalization that can be easily toggled and loaded via middleware
  • en-US base site
  • ja-JP translated site
• Frontend polish
  • Customize the tailwind theme
  • Work in alpine JS for the necessary pizzazz
  • Add in some HTMX hooks for form validation
• Build an automatic tool/script to update the translator yaml entries
• Setup a route for a "Microblog" that I can use to publish my own periodic blog posts

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Localization

Currently localizations are generated manually, but all the strings used in the files can be found with the following command (will work on automating this)

rg 'i18n.T\(ctx,\s*[\"\`]([^\"\`]*)[\"\`]\)' --multiline --multiline-dotall -or '$1'

MakeFile

Run build make command with tests

make all

Build the application

make build

Run the application

make run

Create DB container

make docker-run

Shutdown DB Container

make docker-down

Live reload the application:

make watch

Run the test suite:

make test

Clean up binary from the last build:

make clean