Skip to content

Commit 20c7d8f

Browse files
committed
Refactor project structure and update references to 'lyrica'; add tech stack section in README; enhance index.js with download confirmation prompt.
1 parent 302f487 commit 20c7d8f

File tree

9 files changed

+33
-26
lines changed

9 files changed

+33
-26
lines changed

.github/workflows/go.yml

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,6 @@ jobs:
2626
with:
2727
version: v1.59
2828

29-
# build:
30-
# runs-on: ubuntu-latest
31-
# steps:
32-
# - uses: actions/checkout@v4
33-
34-
# - name: Set up Go
35-
# uses: actions/setup-go@v4
36-
# with:
37-
# go-version: '1.22.4'
38-
39-
# - name: Build
40-
# run: go build -v ./cmd/go-lrc/main.go
41-
4229
release:
4330
name: Create Release
4431
runs-on: ubuntu-latest
@@ -72,7 +59,7 @@ jobs:
7259
echo "GOOS=$GOOS" >> $GITHUB_ENV
7360
echo "GOARCH=$GOARCH" >> $GITHUB_ENV
7461
- name: Build
75-
run: go build -o "$BINARY_NAME" ./.../go-lrc
62+
run: go build -o "$BINARY_NAME" ./.../lyrica
7663

7764
- name: Release Notes
7865
run: git log $(git describe HEAD~ --tags --abbrev=0)..HEAD --pretty='format:* %h %s%n * %an <%ae>' --no-merges >> "${{ github.workspace }}/RELEASE-TEMPLATE.md"

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ The Lyrics Generator is a simple Go application designed to effortlessly create
55
![App Preview](/assets/app.png)
66
_Music: [Please Please Please by Sabrina Carpenter](https://open.spotify.com/track/5N3hjp1WNayUPZrA8kJmJP)_
77

8+
### Tech Stack
9+
10+
- **Frontend:** HTML, Alphine.JS, Tailwind CSS
11+
- **Backend:** Go ([go chi](https://github.com/go-chi/chi))
12+
813
### Features
914

1015
- **Simple Interface:** Easy-to-use application for generating synchronized lyrics.
@@ -14,14 +19,14 @@ _Music: [Please Please Please by Sabrina Carpenter](https://open.spotify.com/tra
1419

1520
### Installation
1621

17-
You can download the binaries from the [GitHub Releases](https://github.com/samocodes/go-lrc/releases) page.
22+
You can download the binaries from the [GitHub Releases](https://github.com/ksamirdev/lyrica/releases) page.
1823

1924
### Usage
2025

2126
1. **Download the Binary:** Obtain the appropriate binary for your operating system from the Releases page.
2227
2. **Run the Application:**
2328
```bash
24-
./go-lrc-[os-arch]
29+
./lyrica-[os-arch]
2530
```
2631
3. **Access the Dashboard:**
2732
- Navigate to `http://localhost:<port>` in your browser (port specified in `.env` file).
@@ -30,7 +35,7 @@ You can download the binaries from the [GitHub Releases](https://github.com/samo
3035

3136
### Contributing
3237

33-
Contributions are welcome! If you find any issues or have suggestions, please open an issue or a pull request on the [GitHub repository](https://github.com/samocodes/go-lrc).
38+
Contributions are welcome! If you find any issues or have suggestions, please open an issue or a pull request on the [GitHub repository](https://github.com/ksamirdev/lyrica).
3439

3540
### License
3641

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import (
55
"net"
66
"net/http"
77

8-
"github.com/samocodes/go-lrc/env"
9-
"github.com/samocodes/go-lrc/web/routes"
8+
"github.com/ksamirdev/lyrica/env"
9+
"github.com/ksamirdev/lyrica/web/routes"
1010
)
1111

1212
type Application struct {

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/ksamirdev/go-lrc
1+
module github.com/ksamirdev/lyrica
22

33
go 1.22.4
44

helpers/helpers.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"net/http"
66
"strings"
77

8-
"github.com/samocodes/go-lrc/types"
8+
"github.com/ksamirdev/lyrica/types"
99
)
1010

1111
func SupportsHTML(r *http.Request) bool {

helpers/helpers_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package helpers
33
import (
44
"testing"
55

6-
"github.com/samocodes/go-lrc/types"
6+
"github.com/ksamirdev/lyrica/types"
77
)
88

99
func TestGenerateLRC(t *testing.T) {

web/routes/routes.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import (
88
"log"
99
"net/http"
1010

11-
"github.com/samocodes/go-lrc/env"
12-
"github.com/samocodes/go-lrc/helpers"
13-
"github.com/samocodes/go-lrc/types"
11+
"github.com/ksamirdev/lyrica/env"
12+
"github.com/ksamirdev/lyrica/helpers"
13+
"github.com/ksamirdev/lyrica/types"
1414

1515
"github.com/go-chi/chi/v5"
1616
"github.com/go-chi/chi/v5/middleware"

web/templates/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
name="description"
1010
content="An open source project for generating lyrics dynamically."
1111
/>
12-
<meta name="author" content="github.com/samocodes" />
12+
<meta name="author" content="github.com/ksamirdev" />
1313

1414
<script src="https://unpkg.com/lucide@latest"></script>
1515
<script

web/templates/index.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,21 @@ document.addEventListener("alpine:init", () => {
4545
},
4646

4747
async _export() {
48+
const shouldContinue = window.confirm(
49+
"If you like this project, please consider starring it on GitHub!\n\nWould you like to continue downloading your resume?"
50+
);
51+
if (shouldContinue) {
52+
// Trigger download
53+
const link = document.createElement("a");
54+
link.href = pdfUrl;
55+
link.download = "resume.pdf";
56+
document.body.appendChild(link);
57+
link.click();
58+
document.body.removeChild(link);
59+
60+
window.open("https://github.com/ksamirdev/lyrica", "_blank");
61+
}
62+
4863
const resp = await fetch("/lrc", {
4964
method: "POST",
5065
body: JSON.stringify({ lyrics: this.lyrics }),

0 commit comments

Comments
 (0)