diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..d5ed451
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,5 @@
+KOITO_ALLOWED_HOSTS=*
+KOITO_LOG_LEVEL=debug
+KOITO_CONFIG_DIR=test_config_dir
+KOITO_DATABASE_URL=postgres://postgres:secret@localhost:5432?sslmode=disable
+TZ=Etc/UTC
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..fbf205d
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+ko_fi: gabehf
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 0000000..677ad0c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug] "
+labels: bug
+assignees: gabehf
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots/Logs**
+If applicable, add screenshots to help explain your problem and any relevant logs with `KOITO_LOG_LEVEL=debug` if possible.
+
+**Version (please complete the following information):**
+ - Koito version: v0.0.X
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..34ecdf9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Enhancement] "
+labels: enhancement
+assignees: gabehf
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Why would you like this feature to be added?**
+A clear description of why this feature might be useful for you will help inform development decisions.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/workflows/astro.yml b/.github/workflows/astro.yml
index 71ee903..428b7b8 100644
--- a/.github/workflows/astro.yml
+++ b/.github/workflows/astro.yml
@@ -1,14 +1,15 @@
name: Deploy to GitHub Pages
on:
- # Trigger the workflow every time you push to the `main` branch
- # Using a different branch name? Replace `main` with your branch’s name
push:
- branches: [main]
- # Allows you to run this workflow manually from the Actions tab on GitHub.
+ tags:
+ - "v*"
+ paths:
+ - "docs/**"
+ - ".github/workflows/**"
+
workflow_dispatch:
-# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
pages: write
@@ -23,9 +24,9 @@ jobs:
- name: Install, build, and upload your site output
uses: withastro/action@v4
with:
- path: ./docs # The root location of your Astro project inside the repository. (optional)
- node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 22. (optional)
- package-manager: yarn@1.22.22 # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+ path: ./docs # The root location of your Astro project inside the repository. (optional)
+ node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 22. (optional)
+ package-manager: yarn@1.22.22 # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
deploy:
needs: build
@@ -36,4 +37,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
- uses: actions/deploy-pages@v4
\ No newline at end of file
+ uses: actions/deploy-pages@v4
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index 0df4d53..466a4f6 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -11,68 +11,65 @@ name: Publish Docker image
on:
push:
- branches: [main]
tags:
- - 'v*'
+ - "v*"
+ branches:
+ - main
+ paths-ignore:
+ - "docs/**"
+ - "README.md"
+
+ workflow_dispatch:
jobs:
test:
name: Go Test
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v4
+ - uses: actions/checkout@v4
- - name: Set up Go
- uses: actions/setup-go@v5
- with:
- go-version-file: go.mod
+ - name: Set up Go
+ uses: actions/setup-go@v5
+ with:
+ go-version-file: go.mod
- - name: Install libvips
- run: |
- sudo apt-get update
- sudo apt-get install -y libvips-dev
+ - name: Install libvips
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y libvips-dev
- - name: Verify libvips install
- run: vips --version
+ - name: Verify libvips install
+ run: vips --version
- - name: Build
- run: go build -v ./...
+ - name: Build
+ run: go build -v ./...
- - name: Test
- uses: robherley/go-test-action@v0
+ - name: Test
+ uses: robherley/go-test-action@v0
push_to_registry:
- name: Push Docker image to Docker Hub
+ name: Push Docker image to Docker Hub (release)
+ if: startsWith(github.ref, 'refs/tags/')
needs: test
runs-on: ubuntu-latest
- permissions:
- packages: write
- contents: read
- attestations: write
- id-token: write
steps:
- - name: Check out the repo
- uses: actions/checkout@v4
+ - uses: actions/checkout@v4
- name: Log in to Docker Hub
- uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
+ uses: docker/login-action@v3
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
- - name: Extract metadata (tags, labels) for Docker
- id: meta
- uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
- with:
- images: gabehf/koito
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
- name: Extract tag version
- id: extract_version
run: echo "KOITO_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
- - name: Build and push Docker image
+ - name: Build and push release image
id: push
- uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
+ uses: docker/build-push-action@v6
with:
context: .
file: ./Dockerfile
@@ -82,10 +79,34 @@ jobs:
gabehf/koito:${{ env.KOITO_VERSION }}
build-args: |
KOITO_VERSION=${{ env.KOITO_VERSION }}
+ platforms: linux/amd64,linux/arm64
- - name: Generate artifact attestation
- uses: actions/attest-build-provenance@v2
+ push_dev:
+ name: Push Docker image (dev branch)
+ if: github.ref == 'refs/heads/main'
+ needs: test
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Log in to Docker Hub
+ uses: docker/login-action@v3
with:
- subject-name: index.docker.io/gabehf/koito
- subject-digest: ${{ steps.push.outputs.digest }}
- push-to-registry: true
+ username: ${{ secrets.DOCKER_USERNAME }}
+ password: ${{ secrets.DOCKER_TOKEN }}
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Build and push dev image
+ uses: docker/build-push-action@v6
+ with:
+ context: .
+ file: ./Dockerfile
+ push: true
+ tags: |
+ gabehf/koito:dev
+ gabehf/koito:dev-${{ github.sha }}
+ build-args: |
+ KOITO_VERSION=dev
+ platforms: linux/amd64,linux/arm64
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..f37ea6a
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,32 @@
+name: Test
+
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ test:
+ name: Go Test
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set up Go
+ uses: actions/setup-go@v5
+ with:
+ go-version-file: go.mod
+
+ - name: Install libvips
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y libvips-dev
+
+ - name: Verify libvips install
+ run: vips --version
+
+ - name: Build
+ run: go build -v ./...
+
+ - name: Test
+ uses: robherley/go-test-action@v0
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..083bb78
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+test_config_dir
+.env
diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index 1a3357e..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# v0.0.3
-## Features
-- Delete listens from the UI
-
-## Enhancements
-- Better behaved mobile UI
-- Search now returns 8 items per category instead of 5
-
-## Fixes
-- Many mobile UI fixes
-
-## Updates
-- Refuses a config that changes the MusicBrainz rate limit while using the official MusicBrainz URL
-- Warns when enabling ListenBrainz relay with missing configuration
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index 3c95c9d..72fd522 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -11,7 +11,7 @@ COPY ./client .
RUN yarn run build
-FROM golang:1.23 AS backend
+FROM golang:1.24 AS backend
ARG KOITO_VERSION
ENV CGO_ENABLED=1
diff --git a/Makefile b/Makefile
index 78c1fb0..99455ac 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,8 @@
+ifneq (,$(wildcard ./.env))
+ include .env
+ export
+endif
+
.PHONY: all test clean client
postgres.schemadump:
@@ -10,7 +15,10 @@ postgres.schemadump:
-v --dbname="koitodb" -f "/tmp/dump/schema.sql"
postgres.run:
- docker run --name koito-db -p 5432:5432 -e POSTGRES_PASSWORD=secret -d postgres
+ docker run --name koito-db -p 5432:5432 -v koito_dev_db:/var/lib/postgresql -e POSTGRES_PASSWORD=secret -d postgres
+
+postgres.run-scratch:
+ docker run --name koito-scratch -p 5433:5432 -e POSTGRES_PASSWORD=secret -d postgres
postgres.start:
docker start koito-db
@@ -18,8 +26,17 @@ postgres.start:
postgres.stop:
docker stop koito-db
-api.debug:
- KOITO_ALLOWED_HOSTS=* KOITO_LOG_LEVEL=debug KOITO_CONFIG_DIR=test_config_dir KOITO_DATABASE_URL=postgres://postgres:secret@localhost:5432?sslmode=disable go run cmd/api/main.go
+postgres.remove:
+ docker stop koito-db && docker rm koito-db
+
+postgres.remove-scratch:
+ docker stop koito-scratch && docker rm koito-scratch
+
+api.debug: postgres.start
+ go run cmd/api/main.go
+
+api.scratch: postgres.run-scratch
+ KOITO_DATABASE_URL=postgres://postgres:secret@localhost:5433?sslmode=disable go run cmd/api/main.go
api.test:
go test ./... -timeout 60s
@@ -33,7 +50,7 @@ client.dev:
docs.dev:
cd docs && yarn dev
-client.deps:
+client.deps:
cd client && yarn install
client.build: client.deps
@@ -41,4 +58,4 @@ client.build: client.deps
test: api.test
-build: api.build client.build
\ No newline at end of file
+build: api.build client.build
diff --git a/README.md b/README.md
index 2bc10ce..b51b2ff 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,21 @@
-# Koito
+
+
+
+
+*Koito (小糸) is a Japanese surname. It is also homophonous with the words 恋と (koi to), meaning "and/with love".*
+
+