Skip to content

Commit

Permalink
Init from lfq
Browse files Browse the repository at this point in the history
  • Loading branch information
danielcmessias committed Oct 11, 2022
0 parents commit 3e7eced
Show file tree
Hide file tree
Showing 45 changed files with 2,981 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/go-release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: goreleaser

on:
push:
tags:
- '*'

permissions:
contents: write

jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
-
name: Set up Go
uses: actions/setup-go@v3
with:
go-version: 1.18
-
name: Run GoReleaser
uses: goreleaser/goreleaser-action@v3
with:
distribution: goreleaser
version: latest
args: release --rm-dist
env:
GITHUB_TOKEN: ${{ secrets.GH_HOMEBREW }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lfq
37 changes: 37 additions & 0 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
before:
hooks:
- go mod tidy
- go mod vendor

builds:
- binary: lfq
goos:
- darwin
- linux
goarch:
- amd64
- arm64
env:
- CGO_ENABLED=0
flags:
- -mod=vendor

release:
prerelease: auto

universal_binaries:
- replace: true

brews:
-
name: lfq
homepage: "https://github.com/danielcmessias/lfq"
tap:
owner: danielcmessias
name: homebrew-tap
commit_author:
name: danielcmessias
email: danielcmessias@gmail.com

checksum:
name_template: 'checksums.txt'
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [year] [fullname]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# lfq (Lake Formation Query)

An AWS Lake Formation Dashboard for your Terminal.

![lfq preview 1](./img/preview01.png)
![lfq preview 2](./img/preview02.png)

More cool things to come (maybe).

# Install

Brew:

```sh
brew tap danielcmessias/tap
brew install danielcmessias/tap/lfq
```

Or download a [binary release](https://github.com/danielcmessias/lfq/releases):

Or build it yourself:

```sh
go build
```

# Usage

Make sure you have AWS credentials set. Press `?` to toggle help.

# Issues

**Q: I don't see the fancy icons in the nav-bar**

**A:** You need a [font](https://www.nerdfonts.com/font-downloads) with icons and a terminal that supports it.


**Q: The layout is behaving weird**

**A:** Try making your window bigger, it's buggy under a minimum size right now.


**Q: I don't like the colour scheme**

**A:** Bad luck, no customization yet. In the meanwhile you can jump on the [Dracula](https://draculatheme.com/) bandwagon.

**Q: Anything else?**
**A:** It's a bug.

# Contributing

Yes please.

---

Built with [Bubble Tea](https://github.com/charmbracelet/bubbletea).

Credit to [gh-dash](https://github.com/dlvhdr/gh-dash) for the starting point!
16 changes: 16 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# SMALL

- [x] Render current account (`sts:GetCallerId`) on the right of tabs view
- Highlight the selected column's cell more visibly (for linking out to resource links?)
- [x] Bundling the search box into the table component (optional to disable), so each table owns the search text

# MEDIUM

- Use termenv for colors
- Link out to useful pages on Enter press (e.g. open browser at s3 location)
- Show LF-Tags for table columns (probably on Schema tab)

# LARGE

- Cache results between sessions
Loading

0 comments on commit 3e7eced

Please sign in to comment.