Nyhetsjeger

README

Nyhetsjeger

Bachelor Project for SMP

Dev environment setup

In order to run and develop this project, you will need a set of tools.

• Visual Studio Code - editor recommanded for this project, tools and plugins listed below transform it into an IDE.

• WSL - We use it for consistant developer experience, as well as development in similar environment to production. Allows us to use Linux-specific toolchains. This simplifies development of scripts.

All tooling below must be accessible in WSL (Except if you are using all tools native to your OS)

• Go - the project is primarily written in GO
  Remember to add go and go's binaries to your path!
  file: ~/.bashrc (or other shell's configuration file), add the following lines at the end of it

  export PATH=$PATH:/usr/local/go/bin
  export PATH=$PATH:$HOME/go/bin
  

• Templ - HTML templating language for Go
  you need it installed in order to generate go files from templates
  • You will also need templ-vscode extension, for improved developer experience.
  • For better IDE support, Tailwind completions etc, check out Templ's guide.
  • For HTMX suggestions in Templ files, you may want to use HTMX Attributes extension.
• Air - Live reload for Go apps
  improved developer experience
• Node to run Tailwind CSS.
  • Recommended installation via Node Version Manager - otherwise WSL might try to run Windows' Node installation, and this will break.
  • You will need Tailwind CSS IntelliSense vscode extension for Tailwind suggestions.
• Docker - for running the database locally and deploying the app
  • WSL will need Docker Desktop for Windows anyway, usually works out the box. For troubleshooting see Docker's and Microsoft's documentation
• migrate CLI - SQL migration tool simplest way to install

  go install -tags 'postgres' github.com/golang-migrate/migrate/v4/cmd/migrate@latest
  

Building and running locally

Use Make to run targets (build, run, etc.) specified in the Makefile. Make is included in most Linux distributions(as well as WSL). If it isnt included by default, use your distros package manager to install it.
Example:

make run

Alternatively, you can check out the commands in the Makefile and run them manually.

Initial setup

Before you can get started running the application you need to get a few things sorted.

Copy the .env.example file to .env.

cp .env.example .env

Change the default passwords and secrets to your own!

Standup the services in docker-compose.

make initialize-docker

And then migrate the database, either

make reset-db

Alternatively, if you don't want dummy/test data

make migrate-up
./scripts/add-db-usr.sh
./scripts/add-nickname-words.sh

Setup a Google Cloud project, generate client ID and secret, update the .env file. This is needed for the OAuth2 login.

Setup MinIO (dashboard can be accessed at localhost:9001). Create a bucket called "images", set public read, generate access and secret keys for write. Set the secrets in the .env file.

Testing

The project has unit and integration tests, they live in separate files and are tagged with go build tags.

unit tests: filename_test.go, build tag unit
integration tests: filename_integration_test.go, build tag integration

Add the build tags to your LSP configuration so you get syntax highlighting and autocompletion in the test files.
VScode settings.json example:

{
    "go.buildFlags": [
        "-tags=integration,unit"
    ],
    "go.testTags": "integration,unit",
}

To run the tests, use specific Make targets

make test-unit
make test-integration

Note: Integration tests use Testcontainers, which requires Docker to be running.

API testing with Bruno

To run the Bruno tets, you need the application running locally.

make run

Then you can run the test suite

make run-bruno

The above uses bru CLI via npx, you may be asked to install it first time you run it.