Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 3.07 KB

README.md

File metadata and controls

83 lines (53 loc) · 3.07 KB
Raw

Go Web Template

This is my (embiem's) favorite Go web stack at the time of making.

I use this to start new web projects quickly and will likely change this template over time.

Note on Security

The simple password auth in this template is just to get going and should be replaced with a more secure approach or additional best practices, before going to production. Always reference the OWASP Top 10 list to ensure you're building a secure app.

Prerequisites

  • install Go
  • install migrate CLI
  • install sqlc
  • install air
  • install templ
  • install tailwindcss-cli v3.4.10
  • cp .env.example .env & fill-in any missing env vars
  • spin-up local dev services like db: docker compose up -d

Local dev

  • run local dev setup via air
  • run tests via go test ./...

DB

Using golang-migrate for migrations (Tutorial) and sqlc for queries, mutations & codegen (Tutorial).

sqlc doc about handling SQL migrations.

Migrations

For local dev, setup env var like so: export POSTGRESQL_URL='postgres://postgres:password@localhost:5432/postgres?sslmode=disable'.

Optionally, test migrations up & down on a separate local db instance e.g. by spinning up a stack with different name: docker compose -p dbmigrations-testing up -d.

  1. Create Migration files: migrate create -ext sql -dir db/migrations -seq your_migration_description
  2. Write the migrations in the created up & down files using SQL
  3. Run up migrations: migrate -database ${POSTGRESQL_URL} -path db/migrations up
  4. Check db & run down migrations to test they work as well: migrate -database ${POSTGRESQL_URL} -path db/migrations down & check db as well
  5. run up migrations again

When dirty, force db to a version reflecting it's real state: migrate -database ${POSTGRESQL_URL} -path db/migrations force VERSION

Important: Write migration SQL in transactions. In Postgres, when we want our queries to be done in a transaction, we need to wrap it with BEGIN and COMMIT commands. Example:

-- up migration
BEGIN;

CREATE TYPE enum_mood AS ENUM (
	'happy',
	'sad',
	'neutral'
);
ALTER TABLE users ADD COLUMN mood enum_mood;

COMMIT;
-- down migration
BEGIN;

ALTER TABLE users DROP COLUMN mood;
DROP TYPE enum_mood;

COMMIT;

Queries, Mutations & Codegen

Write the SQL queries & mutations in db/query.sql and then run sqlc generate.

Templ / View / UI

Using Templ: https://templ.guide/quick-start/creating-a-simple-templ-component

  • templ generate to generate go files after adding or editing .templ files