realworld-backend-go-jet-postgresql

README

Go codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged backend application built with Go including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Go community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

How it works

• It uses a Modular Monolith architecture with clearly defined boundaries and independent modules (users, profiles, and articles).
• It uses the Standard Go Project Layout for codebase organization.
• It uses httprouter to register routes and handlers. See routes.go.
• It uses Jet to build type-safe SQL queries. This project doesn't use an ORM.
• It uses PostgreSQL as database. Locally, the database runs as container see docker-compose.yaml, and all it's data is stored in a volume mapped to the postgres-data folder inside the project (the folder is created automatically when running the container).
• It uses migrate to run migrations. See the migrations folder
• It handles errors in a centralized way.
• It uses Make to run some utility scripts. See the Makefile.

Getting started

1. Run cp .env.template .env. The .env file contains the environment variables used by the application, including secrets.
2. Run make run.