shitlist service

Shitlist is a project service that makes use of several technologies I've wanted to try out.

Getting Started

Install dependencies

In order to generate client and server stubs from our proto, install the buf CLI.

• https://buf.build/docs/installation

This project uses Buf remote plugins, so we no longer need to install the protoc compiler plugins.

Initialize Buf Module

proto$ buf mod init
proto$ buf mod update

Generate code

$ buf lint
$ buf generate

Add

Building the server

$ go build -o ./.bin/shitlist cmd/server/main.go

Configuration

This application is configured via the environment. The following environment
variables can be used:

KEY                           TYPE       DEFAULT                                        REQUIRED    DESCRIPTION
DATABASE_HOST                 String                                                    true        
DATABASE_PORT                 Integer    5432                                                       
DATABASE_USER                 String                                                    true        
DATABASE_PASSWORD             String                                                    true        
DATABASE_SCHEMA_NAME          String                                                    true        
GITHUB_OAUTH_CLIENT_ID        String                                                    true        
GITHUB_OAUTH_CLIENT_SECRET    String                                                    true        
GITHUB_OAUTH_REDIRECT_URL     String     http://localhost:10000/auth/github/callback                
GOOGLE_OAUTH_CLIENT_ID        String                                                    true        
GOOGLE_OAUTH_CLIENT_SECRET    String                                                    true        
GOOGLE_OAUTH_REDIRECT_URL     String     http://localhost:10000/auth/google/callback                
TEMPLATES_DIRECTORY           String     ../../templates                                            
SERVER_LISTEN_ADDRESS         String     :10000

Running the server

$ go run cmd/server/main.go