diff --git a/CHANGELOG.md b/CHANGELOG.md index 833fc49a..99a281e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ - Please follow the update process in *[I just want to update / upgrade my project!](https://github.com/allaboutapps/go-starter/wiki/FAQ#i-just-want-to-update--upgrade-my-project)*. ## Unreleased + +## 2023-05-03 - Switch [from Go 1.19.3 to Go 1.20.3](https://go.dev/doc/devel/release#go1.20) (requires `./docker-helper.sh --rebuild`). - Add new log configuration: - optional `output` param of `LoggerWithConfig` to redirect the log output diff --git a/README.md b/README.md index a4717d76..3f93022d 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ![go starter overview](https://public.allaboutapps.at/go-starter-wiki/go-starter-main-overview.png) -Demo: **[https://go-starter.allaboutapps.at](https://go-starter.allaboutapps.at)** +Demo: **[https://go-starter.allaboutapps.at](https://go-starter.allaboutapps.at)** FAQ: **[https://github.com/allaboutapps/go-starter/wiki/FAQ](https://github.com/allaboutapps/go-starter/wiki/FAQ)** ## Table of Contents @@ -51,11 +51,11 @@ FAQ: **[https://github.com/allaboutapps/go-starter/wiki/FAQ](https://github.com/ - Implements [OAuth 2.0 Bearer Tokens](https://tools.ietf.org/html/rfc6750) and password authentication using [argon2id](https://godoc.org/github.com/alexedwards/argon2id) hashes. - Comes with a tested mock and [FCM](https://firebase.google.com/docs/cloud-messaging) provider for sending push notifications and storing push tokens. - CLI layer provided by [spf13/cobra](https://github.com/spf13/cobra). It's exceptionally easy to [add additional sub-commands via `cobra-cli`](https://github.com/spf13/cobra-cli/blob/main/README.md#add-commands-to-a-project). -- Comes with an initial [PostgreSQL](https://www.postgresql.org/) database structure (see [/migrations](https://github.com/allaboutapps/go-starter/tree/master/migrations)), covering: +- Comes with an initial [PostgreSQL](https://www.postgresql.org/) database structure (see [/migrations](https://github.com/allaboutapps/go-starter/tree/master/migrations)), covering: - auth tokens (access-, refresh-, password-reset-tokens), - a generic auth-related `user` model - an app-specific bare-bones `app_user_profile` model, - - push notification tokens and + - push notification tokens and - a health check sequence (for performing writeable checks). - API endpoints and CLI for liveness (`/-/healthy`) and readiness (`/-/ready`) probes - Parallel jobs optimized `Makefile` and various convenience scripts (see all targets and its description via `make help`). A full rebuild only takes seconds. @@ -85,7 +85,7 @@ Please refer to the [official installation guide](https://code.visualstudio.com/ ### Quickstart -Create a new git repository through the GitHub template repository feature ([use this template](https://github.com/allaboutapps/go-starter/generate)). You will then start with a **single initial commit** in your own repository. +Create a new git repository through the GitHub template repository feature ([use this template](https://github.com/allaboutapps/go-starter/generate)). You will then start with a **single initial commit** in your own repository. ```bash # Clone your new repository, cd into it, then easily start the docker-compose dev environment through our helper @@ -178,7 +178,7 @@ make make test ``` -### Running +### Running To run the service locally you may: @@ -223,6 +223,7 @@ Please make sure to update tests as appropriate. ## Current maintainers +- [Anna - @anjankow](https://github.com/anjankow) - [Michael Farkas - @farkmi](https://github.com/farkmi) - [Mario Ranftl - @majodev](https://github.com/majodev) - [Manuel Wieser - @mwieser](https://github.com/mwieser)