TWHelp core code repository.
https://tribalwarshelp.com/api/v1/swagger/index.html
ci/woodpecker/push/test Pipeline was successful
Details
ci/woodpecker/tag/docker Pipeline was successful
Details
ci/woodpecker/tag/deploy Pipeline was successful
Details
ci/woodpecker/cron/govulncheck Pipeline was successful
Details
Reviewed-on: #252 |
||
---|---|---|
.woodpecker | ||
build/docker | ||
cmd/twhelp | ||
docs | ||
internal | ||
k8s | ||
migrations | ||
.commitlintrc.yml | ||
.dockerignore | ||
.envrc | ||
.gitignore | ||
.golangci.yml | ||
.pre-commit-config.yaml | ||
LICENSE | ||
Makefile | ||
README.md | ||
go.mod | ||
go.sum | ||
renovate.json | ||
skaffold.yml |
README.md
core
TWHelp is a project aiming to provide:
- Easy access to Tribal Wars data, for both users and developers.
- Scripts & tools to facilitate gameplay.
Getting started
Development
Setting up the environment
Prerequisites:
- Go (>= 1.19)
- Node.js (LTS, needed for commitlint)
- Kubernetes (>= 1.25.0)
- minikube
- Docker Desktop
- Docker CLI
- Skaffold
- pre-commit
- IDE/Code editor (e.g. Goland, VSCode, vim, neovim)
- direnv (optional, but recommended)
# if you have direnv installed
direnv allow
# install git hooks and required tools
make install
# run all required services
skaffold run --port-forward=true --tail=true
# stop all of them
skaffold delete
Running unit tests
At least one of the following is required to run unit tests:
- Docker (dockertest will spin up a database)
- Postgres database
# Docker
go test -v ./...
# Postgres database
TESTS_DB_DSN=postgres://twhelp:twhelp_pass@127.0.0.1/twhelp go test -v ./...
Creating a new database migration
# create a migration
go run ./cmd/twhelp/main.go db create go migration 1
Configuration options
Configuration options can be specified via environment variables.
Env variable | Default | Description |
---|---|---|
APP_MODE |
development |
Whether to use development or production settings |
DB_DSN |
Required. Only Postgres is supported. Example: postgres://user:password@host:5432/dbname?sslmode=disable (https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) |
|
DB_MAX_OPEN_CONNECTIONS |
5 |
Maximum number of open connections to the database (https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) |
DB_MAX_IDLE_CONNECTIONS |
2 |
Maximum number of connections in the idle connection pool (https://pkg.go.dev/database/sql#DB.SetMaxIdleConns) |
DB_CONNECTION_MAX_LIFETIME |
3m |
Maximum amount of time a connection may be reused (https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime) |
AMQP_URI |
Required. Example: amqp://user:password@host:5672/ (https://www.rabbitmq.com/uri-spec.html) |
|
AMQP_PREFETCH_COUNT |
2 |
https://www.rabbitmq.com/consumer-prefetch.html |
API_SWAGGER_ENABLED |
false |
Enables the API documentation endpoints (e.g. /api/v1/swagger/index.html , /api/v1/swagger/doc.json ) |
API_SWAGGER_HOST |
Host (name or ip) serving the API (e.g. tribalwarshelp.com) | |
API_SWAGGER_SCHEMES |
http,https |
Comma-separated list of protocols |
API_CORS_ENABLED |
false |
Enables CORS headers |
API_CORS_ALLOWED_ORIGINS |
Comma-separated list of allowed domains | |
API_CORS_ALLOW_CREDENTIALS |
false |
Whether requests with credentials are allowed |
API_CORS_ALLOWED_METHODS |
HEAD,GET |
Comma-separated list of allowed methods |
API_CORS_MAX_AGE |
300 |
Max time to cache response (seconds) |
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Dawid Wysokiński - contact@dwysokinski.me