Chore/rewrite

.env.example

@@ -0,0 +1,3 @@
+APP_ENV = development
+SONG_SPOTIFY_CLIENT_ID = your_client_id
+SONG_SPOTIFY_CLIENT_SECRET = your_client_secret

.githooks/pre-commit

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+echo "Linting"
+golangci-lint run
+if [ $? -ne 0 ]; then
+    echo "golangci-lint failed. Please fix the errors before committing."
+    exit 1
+fi

.github/workflows/golangci-lint.yml

@@ -0,0 +1,30 @@
+name: golangci-lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.23.1
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.60

.github/workflows/sqlc-diff.yml

@@ -0,0 +1,12 @@
+name: sqlc
+on: [push]
+
+jobs:
+  diff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: sqlc-dev/setup-sqlc@v3
+      with:
+        sqlc-version: '1.27.0'
+    - run: sqlc diff

.gitignore

@@ -1,14 +1,11 @@
-# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
 # Binaries for programs and plugins
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
 
-# Test binary, built with `go test -c`
+# Test binary, built with "go test -c"
 *.test
 
 # Output of the go coverage tool, specifically when used with LiteIDE
@@ -19,12 +16,22 @@
 
 # Go workspace file
 go.work
+tmp/
 
-tmp.go
+# IDE specific files
+.vscode
+.idea
 
-config.yaml
+# .env file
+.env
+.env.*
+!.env.example
 
-# Binary
-scc
-# Log file
-scc.log
+# Project build
+backend_bin
+tui_bin
+
+.data/
+
+# Log files
+logs/

.golangci.yml

@@ -0,0 +1,35 @@
+run:
+  timeout: 5m
+  modules-download-mode: readonly
+
+linters:
+  enable:
+    - bodyclose # checks whether HTTP response body is closed successfully
+    - copyloopvar # detects copy loop variable
+    - errcheck # checks for unchecked errors in go programs
+    - errname # checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`
+    - gochecknoinits # checks that no init functions are present in Go code
+    - goimports # check import statements are formatted correctly
+    - gosimple # checks for code simplifications in Go code
+    - govet # runs the go vet tool
+    - importas # enforces consistent import aliases
+    - ineffassign # detects when assignments to existing variables are not used
+    - noctx # finds sending http request without context.Context
+    - paralleltest # detects missing usage of t.Parallel() method in go tests
+    - prealloc # finds slice declarations that could potentially be preallocated
+    - revive # checks for golang coding style
+    - rowserrcheck # checks whether Err of rows is checked successfully
+    - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
+    - staticcheck # Applies static code analysis
+    - tenv # detects using os.Setenv instead of t.Setenv
+    - testpackage # makes you use a separate _test package
+    - thelper # detects golang test helpers without t.Helper() call and checks consistency of test helpers
+    - unconvert # removes unnecessary type conversions
+    - unparam # removes unused function parameters
+    - unused # finds unused variables
+  fast: true
+
+issues:
+  exclude-use-default: false
+  max-issues-per-linter: 0
+  max-same-issues: 0

.tool-versions

@@ -1 +1 @@
-golang 1.22.0
+golang 1.23.1

README.md

@@ -1,7 +1,70 @@
 # Screen Cammie Chat
 
-Go 1.22.0
+Displays the cammie chat along with some other statistics.
 
-- `go mod tidy`
+## Development Setup
 
-- `go run .` of `go build .`
+### Prerequisites
+
+1. Go: Check the [.tool-versions](.tool-versions) file for the required Go version.
+2. Pre-commit hooks: `git config --local core.hooksPath .githooks/`.
+3. Goose (DB migrations): `go install github.com/pressly/goose/v3/cmd/goose@latest`.
+4. SQLC (Statically typed queries): `go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest`
+5. Make (Optional)
+
+### Configuration
+
+1. Create a `.env` file specifying
+  - `APP_ENV`. Available options are:
+     -  `development`
+     -  `production`
+  - `BACKEND_SONG_SPOTIFY_CLIENT_ID`
+  - `BACKEND_SONG_SPOTIFY_CLIENT_SECRET`
+2. Configure the appropriate settings in the corresponding configuration file located in the [config directory](./config). you can either set them as environment variables or inside the configuration file.
+
+## DB
+
+This project uses a postgres database.
+SQLC is used to generate statically typed queries and goose is responsible for the database migrations.
+
+### Usefull commands
+
+- `make db`: Start the database
+- `make migrate`: Run database migrations to update your database schema (watch out, migrations might result in minor data loss).
+- `make create-migration`: Create a new migration in the [db/migrations](./db/migrations/) directory.
+- `make sqlc`: Generate statically typed queries based on the .sql files in the [db/queries](./db/queries/) directory. Add new queries to this directory as needed.
+
+## Backend
+
+The backend is responsible for fetching and processing external data, which is then stored in the database.
+Data can either received by exposing an API or by actively fetching them.
+
+### Running the backend
+
+To build and run the backend, use the following commands:
+
+- `make build-backend`: Build the backend binary.
+- `make run-backend`: Run the backend.
+
+### Logs
+
+Backend logs are saved to `./logs/backend.log` (created on first start) and written to `stdout`.
+
+## TUI
+
+The TUI (Text User Interface) displays data retrieved from the database. This flexibility allows for running multiple instances of the TUI, each displaying different data.
+
+### Running the TUI
+
+To build and run the TUI, use the following commands:
+
+- `make build-tui`: Build the TUI binary.
+- `make run-tui`: Run the TUI.
+-
+The TUI requires one argument: the screen name to display. You can create new screens in the [screens directory](./tui/screen/), and you must add them to the startup command list in [tui.go](./internal/cmd/tui.go).
+
+A screen is responsible for creating and managing the layout, consisting of various [views](./tui/view/).
+
+### Logs
+
+TUI logs are written to `./logs/tui.log` and _not_ to `stdout`.