Skip to content

Commit

Permalink
chore: rename project
Browse files Browse the repository at this point in the history
  • Loading branch information
steveiliop56 committed Dec 3, 2024
1 parent 8363bc5 commit b9e677b
Show file tree
Hide file tree
Showing 18 changed files with 67 additions and 70 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ DISCORD=your-discord-token
RUNTIPI=runtipi-server-url
JWT_SECRET=your-jwt-secret
APPSTORE=https://github.com/runtipi/runtipi-appstore
DB_PATH=/data/tipicord.db
DB_PATH=/data/tipimate.db
REFRESH=30
10 changes: 5 additions & 5 deletions .github/workflows/alpha-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ jobs:
go-version: 1.23.2

- name: Build
run: go build -o tipicord-${{ matrix.os }}-${{ matrix.arch }}
run: go build -o tipimate-${{ matrix.os }}-${{ matrix.arch }}
env:
GOARCH: ${{ matrix.arch }}
GOOS: ${{ matrix.os }}

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: tipicord-${{ matrix.os }}-${{ matrix.arch }}
path: tipicord-${{ matrix.os }}-${{ matrix.arch }}
name: tipimate-${{ matrix.os }}-${{ matrix.arch }}
path: tipimate-${{ matrix.os }}-${{ matrix.arch }}

build-docker:
needs: [get-tag, build]
Expand Down Expand Up @@ -71,7 +71,7 @@ jobs:
context: .
push: true
platforms: linux/arm64, linux/amd64
tags: ghcr.io/${{ github.repository_owner }}/tipicord:${{ needs.get-tag.outputs.tag }}
tags: ghcr.io/${{ github.repository_owner }}/tipimate:${{ needs.get-tag.outputs.tag }}

alpha-release:
needs: [get-tag, build, build-docker]
Expand All @@ -80,7 +80,7 @@ jobs:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
pattern: tipicord-*
pattern: tipimate-*
path: binaries
merge-multiple: true

Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/beta-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ jobs:
go-version: 1.23.2

- name: Build
run: go build -o tipicord-${{ matrix.os }}-${{ matrix.arch }}
run: go build -o tipimate-${{ matrix.os }}-${{ matrix.arch }}
env:
GOARCH: ${{ matrix.arch }}
GOOS: ${{ matrix.os }}

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: tipicord-${{ matrix.os }}-${{ matrix.arch }}
path: tipicord-${{ matrix.os }}-${{ matrix.arch }}
name: tipimate-${{ matrix.os }}-${{ matrix.arch }}
path: tipimate-${{ matrix.os }}-${{ matrix.arch }}

build-docker:
needs: [get-tag, build]
Expand Down Expand Up @@ -71,7 +71,7 @@ jobs:
context: .
push: true
platforms: linux/arm64, linux/amd64
tags: ghcr.io/${{ github.repository_owner }}/tipicord:${{ needs.get-tag.outputs.tag }}
tags: ghcr.io/${{ github.repository_owner }}/tipimate:${{ needs.get-tag.outputs.tag }}

beta-release:
needs: [get-tag, build, build-docker]
Expand All @@ -80,7 +80,7 @@ jobs:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
pattern: tipicord-*
pattern: tipimate-*
path: binaries
merge-multiple: true

Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ jobs:
go-version: 1.23.2

- name: Build
run: go build -o tipicord-${{ matrix.os }}-${{ matrix.arch }}
run: go build -o tipimate-${{ matrix.os }}-${{ matrix.arch }}
env:
GOARCH: ${{ matrix.arch }}
GOOS: ${{ matrix.os }}

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: tipicord-${{ matrix.os }}-${{ matrix.arch }}
path: tipicord-${{ matrix.os }}-${{ matrix.arch }}
name: tipimate-${{ matrix.os }}-${{ matrix.arch }}
path: tipimate-${{ matrix.os }}-${{ matrix.arch }}

build-docker:
needs: [get-tag, build]
Expand Down Expand Up @@ -68,7 +68,7 @@ jobs:
context: .
push: true
platforms: linux/arm64, linux/amd64
tags: ghcr.io/${{ github.repository_owner }}/tipicord:${{ needs.get-tag.outputs.tag }}, ghcr.io/${{ github.repository_owner }}/tipicord:latest
tags: ghcr.io/${{ github.repository_owner }}/tipimate:${{ needs.get-tag.outputs.tag }}, ghcr.io/${{ github.repository_owner }}/tipimate:latest

release:
needs: [get-tag, build, build-docker]
Expand All @@ -77,7 +77,7 @@ jobs:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
pattern: tipicord-*
pattern: tipimate-*
path: binaries
merge-multiple: true

Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# database
tipicord.db
tipimate.db

# vscode debugger
.vscode

# Build out
tipicord
tipicord.exe
tipimate
tipimate.exe

# Env
.env
Expand Down
10 changes: 5 additions & 5 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ COPY cmd/ cmd/

RUN go mod tidy

RUN go build -ldflags "-s -w" -o tipicord main.go
RUN go build -ldflags "-s -w" -o tipimate main.go

# --- RUNNER ----
FROM alpine:3.20 AS runner

WORKDIR /tipicord
WORKDIR /tipimate

RUN mkdir /data

COPY --from=builder /build/tipicord /tipicord
COPY --from=builder /build/tipimate /tipimate

ENV DB_PATH=/data/tipicord.db
ENV DB_PATH=/data/tipimate.db

ENTRYPOINT ["/tipicord/tipicord", "server"]
ENTRYPOINT ["/tipimate/tipimate", "server"]
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# TipiCord
# TipiMate

TipiCord is an extremely simple tool that periodically checks for app updates in your [Runtipi](https://github.com/runtipi/runtipi) instance and then sends notifications to your prefered Discord channel/server. It is super fast, lightweight and only ~20mb in size.
TipiMate is an extremely simple tool that periodically checks for app updates in your [Runtipi](https://github.com/runtipi/runtipi) instance and then sends notifications to your prefered Discord channel/server. It is super fast, lightweight and only ~20mb in size.

> [!NOTE]
> TipiCord only supports runtipi instances from v3.7.0 and above since this version added the ability to use an API to communicate with the server.
> TipiMate only supports runtipi instances from v3.7.0 and above since this version added the ability to use an API to communicate with the server.
> [!WARNING]
> TipiCord is still in early stages of development so issues are to be expected. If you encounter any please create an issue so I can fix them as soon as possible.
> TipiMate is still in early stages of development so issues are to be expected. If you encounter any please create an issue so I can fix them as soon as possible.
## Roadmap

Expand All @@ -19,14 +19,14 @@ This project is still in early stages of development so it only includes the bas

## Getting started

You can run tipicord with two ways, docker or binary. If you chose binary, you can grab the latest binary from the [releases](https://github.com/steveiliop56/tipicord/releases) page, then `chmod +x tipicord` and finally you can run it with `./tipicord`. *assuming the binary is named tipicord*
You can run tipimate with two ways, docker or binary. If you chose binary, you can grab the latest binary from the [releases](https://github.com/steveiliop56/tipimate/releases) page, then `chmod +x tipimate` and finally you can run it with `./tipimate`. *assuming the binary is named tipimate*

Running with docker is also very easy, you just need to download the docker compose file from [here](./docker-compose.yml) and run tipicord with `docker compose up -d`. *make sure to change the environment variables accordingly*
Running with docker is also very easy, you just need to download the docker compose file from [here](./docker-compose.yml) and run tipimate with `docker compose up -d`. *make sure to change the environment variables accordingly*

If you prefer docker run command you can run it with

```bash
docker run -t -d --name tipicord -v ./data:/data -e DISCORD=your-discord-url -e RUNTIPI=your-runtipi-url -e JWT_SECRET=your-jwt-secret ghcr.io/steveiliop56/tipicord:latest
docker run -t -d --name tipimate -v ./data:/data -e DISCORD=your-discord-url -e RUNTIPI=your-runtipi-url -e JWT_SECRET=your-jwt-secret ghcr.io/steveiliop56/tipimate:latest
```

## Building
Expand All @@ -36,8 +36,8 @@ To build the project you need to have Go and Git installed.
You firstly have to clone the repository with

```bash
git clone https://github.com/steveiliop56/tipicord
cd tipicord
git clone https://github.com/steveiliop56/tipimate
cd tipimate
```

Then install dependencies
Expand All @@ -58,7 +58,7 @@ Or build it with
got build
```

If everything succeeds you should have a binary named `tipicord`.
If everything succeeds you should have a binary named `tipimate`.

> [!NOTE]
> You can also build for other operating systems/architectures using `GOOS=windows` and `GOARCH=arm64`.
Expand All @@ -72,4 +72,4 @@ This project is still in early stages of development so bugs are to be expected.

## License

TipiCord is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
TipiMate is licensed under the GNU General Public License v3.0. TL;DR — You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.
10 changes: 5 additions & 5 deletions cmd/check.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import (
"errors"
"fmt"
"net/url"
"tipicord/internal/api"
"tipicord/internal/assets"
"tipicord/internal/spinner"
"tipicord/internal/types"
"tipicord/internal/utils"
"tipimate/internal/api"
"tipimate/internal/assets"
"tipimate/internal/spinner"
"tipimate/internal/types"
"tipimate/internal/utils"

"github.com/fatih/color"
"github.com/gookit/validate"
Expand Down
7 changes: 2 additions & 5 deletions cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,11 @@ import (
"github.com/spf13/cobra"
)

// Viper
// var cmdViper = viper.New()

// Main command
var rootCmd = &cobra.Command{
Use: "tipicord",
Use: "tipimate",
Short: "Discord notifications for your runtipi server",
Long: "TipiCord is a simple tool that monitors your runtipi server for app updates and notifies you via Discord notifications",
Long: "TipiMate is a simple tool that monitors your runtipi server for app updates and notifies you via Discord notifications",
}

// Execute command
Expand Down
14 changes: 7 additions & 7 deletions cmd/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import (
"os"
"strconv"
"time"
"tipicord/internal/alerts"
"tipicord/internal/api"
"tipicord/internal/assets"
"tipicord/internal/database"
"tipicord/internal/types"
"tipicord/internal/utils"
"tipimate/internal/alerts"
"tipimate/internal/api"
"tipimate/internal/assets"
"tipimate/internal/database"
"tipimate/internal/types"
"tipimate/internal/utils"

"github.com/containrrr/shoutrrr/pkg/router"
"github.com/gookit/validate"
Expand Down Expand Up @@ -169,7 +169,7 @@ func init() {
serverCmd.Flags().String("runtipi", "", "Runtipi server URL")
serverCmd.Flags().String("jwt-secret", "", "JWT secret")
serverCmd.Flags().String("appstore", "https://github.com/runtipi/runtipi-appstore", "Appstore URL for images")
serverCmd.Flags().String("db-path", "tipicord.db", "Database path")
serverCmd.Flags().String("db-path", "tipimate.db", "Database path")
serverCmd.Flags().Int("refresh", 30, "Refresh interval")
serverViper.BindEnv("jwt-secret", "JWT_SECRET")
serverViper.BindEnv("db-path", "DB_PATH")
Expand Down
8 changes: 4 additions & 4 deletions cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@ package cmd

import (
"fmt"
"tipicord/internal/assets"
"tipimate/internal/assets"

"github.com/spf13/cobra"
)

// Command
var versionCmd = &cobra.Command{
Use: "version",
Short: "Print the version number of TipiCord",
Long: "All software has versions. This is TipiCord's",
Short: "Print the version number of TipiMate",
Long: "All software has versions. This is TipiMate's",
Run: func(cmd *cobra.Command, args []string) {
fmt.Printf("TipiCord %s\n", assets.Version)
fmt.Printf("TipiMate %s\n", assets.Version)
},
}

Expand Down
4 changes: 2 additions & 2 deletions docker-compose.dev.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
services:
tipicord:
tipimate:
build:
context: .
dockerfile: Dockerfile
container_name: tipicord
container_name: tipimate
restart: unless-stopped
env_file: .env
volumes:
Expand Down
8 changes: 4 additions & 4 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
services:
tipicord:
image: ghcr.io/steveiliop56/tipicord:latest
container_name: tipicord
tipimate:
image: ghcr.io/steveiliop56/tipimate:latest
container_name: tipimate
restart: unless-stopped
volumes:
- ./data:/data
Expand All @@ -10,5 +10,5 @@ services:
- RUNTIPI=runtipi-server-url
- JWT_SECRET=your-jwt-secret
- APPSTORE=https://github.com/runtipi/runtipi-appstore
- DB_PATH=/data/tipicord.db
- DB_PATH=/data/tipimate.db
- REFRESH=30
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module tipicord
module tipimate

go 1.23.2

Expand Down
8 changes: 4 additions & 4 deletions internal/alerts/alerts.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import (
"encoding/json"
"fmt"
"time"
"tipicord/internal/constants"
"tipicord/internal/types"
"tipicord/internal/utils"
"tipimate/internal/constants"
"tipimate/internal/types"
"tipimate/internal/utils"

"github.com/containrrr/shoutrrr"
"github.com/google/go-querystring/query"
Expand Down Expand Up @@ -36,7 +36,7 @@ func SendAppUpdateAlert(info *types.AppUpdateAlert) (error) {
},
}
message.AvatarUrl = constants.RuntipiLogoUrl
message.Username = "TipiCord"
message.Username = "TipiMate"

// Query params
var webhook types.Webhook
Expand Down
2 changes: 1 addition & 1 deletion internal/api/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"encoding/json"
"fmt"
"net/http"
"tipicord/internal/types"
"tipimate/internal/types"

"github.com/golang-jwt/jwt/v5"
)
Expand Down
2 changes: 1 addition & 1 deletion internal/utils/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"os"
"strings"
"tipicord/internal/spinner"
"tipimate/internal/spinner"

"github.com/rs/zerolog/log"
)
Expand Down
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package main

import (
"tipicord/cmd"
"tipimate/cmd"
)

func main() {
Expand Down

0 comments on commit b9e677b

Please sign in to comment.