initial commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: File a bug/issue
+title: '[Bug]: '
+labels: bug
+assignees: ''
+---
+
+Your issue may already be reported!
+Please search on the [issue tracker](../) before creating one.
+
+### Prerequisites
+
+* [ ] Are you running the latest version?
+* [ ] Did you check other issues?
+* [ ] Can you reproduce the problem?
+* [ ] Provide a minimal code snippet example that reproduces the bug.
+
+
+### Description
+
+[Description of the bug]
+
+### Steps to Reproduce
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expected to happen]
+
+**Actual behavior:** [What actually happened]
+
+### Versions
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: "Suggest an idea for this project"
+title: '[Proposal]: '
+labels: proposal
+assignees: ''
+---
+
+Your issue may already be reported!
+Please search on the [issue tracker](../) before creating one.
+
+## Feature Request
+
+### Description
+
+[A clear and concise description of what the problem is. Ex. I have an issue when]
+
+### Solution
+
+[A clear and concise description of what you want to happen. Add any considered drawbacks.]
+
+### Alternative solutions / Recommendations / Workarounds
+
+[A clear and concise description of any alternative solutions or features you've considered.]
+
+### Documentation, Adoption, Migration Strategy
+[If you can, explain how users will be able to use this.]

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+### Description
+Describe your work here.
+
+### Scope
+> What is affected by this pull request?
+
+- [ ] Bug Fix
+- [ ] New Feature
+- [ ] Documentation
+- [ ] Other
+
+### Related Issue
+Fixes #
+
+
+### To-Do Checklist
+- [ ] I tested my changes
+- [ ] I have commented every method that I created/changed
+- [ ] I updated the examples to fit with my changes
+- [ ] I have added tests for my newly created methods

.github/settings.yml

@@ -0,0 +1,19 @@
+_extends: .github
+
+repository:
+    description: 📰 Hackertea a TUI for Hackernews.
+    homepage: https://github.com/KarolosLykos/hackerteae
+    topics: go, cli, tui, golang, hackernews, bubbletea, lipgloss, bubble, elm-architecture, terminal
+    private: true
+
+branches:
+  - name: main
+    protection:
+      required_pull_request_reviews:
+        required_approving_review_count: 1
+        dismiss_stale_reviews: true
+        require_code_owner_reviews: true
+      required_status_checks:
+        strict: true
+        contexts: []
+      required_linear_history: true

.github/workflows/go.yml

@@ -0,0 +1,36 @@
+name: Go
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    steps:
+
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v4
+        with:
+          go-version: ^1
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: Get dependencies
+        run: go get -v -t -d ./...
+
+      - name: Build
+        run: go build -v .
+
+      - name: Test
+        run: go test -coverprofile="coverage.txt" -covermode=atomic -p 1 ./...
+
+      - name: Upload coverage to Codecov
+        if: success() && matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v3.1.4
+        with:
+            token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release-test.yml

@@ -0,0 +1,23 @@
+name: release-test
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.19
+      - name: Run GoReleaser Tests
+        uses: goreleaser/goreleaser-action@v4
+        with:
+          version: latest
+          args: --snapshot --skip-publish --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  id-token: write
+  packages: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v4
+        with:
+          go-version: 1.19
+      - uses: goreleaser/goreleaser-action@v4
+        with:
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/vhs.yml

@@ -0,0 +1,25 @@
+name: vhs
+on:
+  push:
+    paths:
+      - vhs.tape
+jobs:
+  vhs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: charmbracelet/vhs-action@v2.0.0
+        with:
+          path: 'vhs.tape'
+        env:
+          TERM: xterm-256color
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit_message: Update generated VHS GIF
+          branch: main
+          commit_user_name: vhs-action 📼
+          commit_user_email: actions@github.com
+          commit_author: vhs-action 📼 <actions@github.com>
+          file_pattern: '*.gif'

.gitignore

@@ -0,0 +1,35 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+coverage.html
+
+# Dependency directories (remove the comment below to include it)
+#vendor/
+
+# Output of GoReleaser
+dist/
+
+# MacOS DS_Store files
+.DS_Store
+
+# Visual Studio Code files
+.vscode/
+
+# Local History for Visual Studio Code
+.history/
+
+# Goland and Intellij IDEA files
+.idea/
+
+# env files that usually contain secrets or local config
+.env
+.envrc

.goreleaser.yaml

@@ -0,0 +1,43 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+before:
+  hooks:
+    - go mod tidy
+
+gomod:
+  proxy: true
+
+builds:
+  - env: ["CGO_ENABLED=0"]
+    mod_timestamp: "{{ .CommitTimestamp }}"
+    flags: ["-trimpath"]
+    targets: ["go_first_class"]
+
+changelog:
+  sort: asc
+  use: github
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+      - "^chore"
+      - Merge pull request
+      - Merge remote-tracking branch
+      - Merge branch
+      - go mod tidy
+  groups:
+    - title: "New Features"
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 10
+    - title: Other work
+      order: 999
+
+release:
+  footer: |
+
+    ---
+
+    _Released with [GoReleaser](https://goreleaser.com)!_

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thank you for considering contributing to Hackertea
+
+You can contribute in the following ways:
+
+- Finding and reporting bugs
+- Contributing code to Hackertea by fixing bugs or implementing features
+- Improving the documentation
+
+## Bug reports
+
+Bug reports and feature suggestions must use descriptive and concise titles and be submitted to [GitHub Issues](https://github.com/KarolosLykos/hackertea/issues). Please use the search function to make sure that you are not submitting duplicates, and that a similar report or request has not already been resolved or rejected.
+
+## Pull requests
+
+**Please use clean, concise titles for your pull requests.** Unless the pull request is about refactoring code, updating dependencies or other internal tasks, assume that the person reading the pull request title is not a programmer, and **try to describe your change or fix**. The final commit in the main branch will carry the title of the pull request.
+
+## Documentation
+
+The [Hackertea documentation](https://github.com/KarolosLykos/hackertea/blob/main/README.md).