Skip to content

Commit 54ae975

Browse files
Coding-MeetCoding-Meet
committed
feat: Enhance build configuration, internationalization, and documentation
This commit introduces several improvements across the project, including a more robust build process for native distributions, internationalization support, and comprehensive project documentation. - **Build & Distribution:** - Configures native distribution formats for macOS (`.dmg`, `.pkg`), Windows (`.msi`, `.exe`), and Linux (`.deb`, `.rpm`). - Sets application metadata such as `packageName`, `version`, `description`, `vendor`, and `copyright`. - Adds custom icons for each platform (`.icns`, `.ico`, `.png`). - Implements Proguard for code obfuscation and optimization in release builds. - Sets the JVM toolchain to version 17. - Adds an `Apache 2.0` license file and a `.github/FUNDING.yml` for sponsorships. - Disables debug logging in `AppLogger`. - **Internationalization (i18n):** - Adds a `strings.xml` resource file to externalize all user-facing strings. - Integrates `org.jetbrains.compose.resources` to load string resources throughout the UI, replacing hardcoded text. - Components updated include buttons, dialogs, input fields, and labels. - **UI & UX:** - Sets a main window icon and title using resource APIs. - Removes unused DataStore and navigation-related code. - Cleans up minor code formatting in UI components. - **Documentation:** - Updates `README.md` with a detailed project description, feature list, usage instructions, tech stack, and screenshots. - Adds sections for generating a GitHub Personal Access Token and future goals.
1 parent 1c557a3 commit 54ae975

File tree

22 files changed

+557
-105
lines changed

22 files changed

+557
-105
lines changed

‎.github/FUNDING.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
buy_me_a_coffee: codingmeet
2+
# # These are supported funding model platforms
3+
4+
# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
5+
# patreon: # Replace with a single Patreon username
6+
# open_collective: # Replace with a single Open Collective username
7+
# ko_fi: # Replace with a single Ko-fi username
8+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
9+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
10+
# liberapay: # Replace with a single Liberapay username
11+
# issuehunt: # Replace with a single IssueHunt username
12+
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
13+
# polar: # Replace with a single Polar username
14+
# buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
15+
# thanks_dev: # Replace with a single thanks.dev username
16+
# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [2025] [Meet]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 106 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,63 @@
1-
This is a Kotlin Multiplatform project targeting Desktop (JVM).
1+
# 🧩 Git Backup Hub
22

3-
* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications.
4-
It contains several subfolders:
5-
- [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s common for all targets.
6-
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
7-
For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
8-
the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls.
9-
Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin)
10-
folder is the appropriate location.
3+
**Git Backup Hub** is a cross-platform desktop application built with **Kotlin Multiplatform** and **Compose for Desktop**, designed to help developers easily back up their GitHub repositories — both public and private — with progress tracking and elegant UI.
114

12-
### Build and Run Desktop (JVM) Application
5+
---
6+
7+
## 🚀 Features
8+
9+
- **Fetch Repositories** — Retrieve all repositories (public & private) for any GitHub user.
10+
- **Private Repositories** — Use a **Personal Access Token (PAT)** to fetch and clone private repos.
11+
- **Selective Backup** — Select one or multiple repositories to back up.
12+
- **Destination Path** — Choose any local folder as your backup destination.
13+
- **Progress Tracking** — Real-time progress with percentage, ETA, and logs.
14+
- **Search & Filter** — Quickly find repositories by name or type.
15+
- **Cancel Download** — Stop an active download at any time.
16+
- **Modern UI** — Clean Material 3 design inspired by GitHub’s dark and light themes.
17+
18+
---
19+
20+
## 🧠 How to Use
21+
22+
1. Enter your **GitHub username**.
23+
2. (Optional) Toggle **“Use Access Token”** and provide your Personal Access Token to access private repositories.
24+
3. Click **Fetch** to load all repositories.
25+
4. Select repositories manually or use **“Select All”**.
26+
5. Click **Browse** to choose a local backup folder.
27+
6. Click **Download Repositories** to start the backup process.
28+
7. Track progress, cancel downloads, or monitor logs in real-time.
29+
30+
---
31+
32+
## 🔑 How to Generate a Personal Access Token
1333

14-
To build and run the development version of the desktop app, use the run configuration from the run widget
15-
in your IDE’s toolbar or run it directly from the terminal:
34+
1. Go to **GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens**.
35+
2. Or use the direct link:
36+
[https://github.com/settings/personal-access-tokens](https://github.com/settings/personal-access-tokens)
37+
3. Click **Generate new token**.
38+
4. Select all scopes (or at least `repo` and `read:user`).
39+
5. Copy the token and paste it into Git Backup Hub when prompted.
40+
41+
![Generate Token Screenshot](screenshot/generate_token.png)
42+
43+
---
44+
45+
## 🧰 Tech Stack
46+
47+
| Layer | Technology |
48+
|-------|-------------|
49+
| UI | Compose for Desktop (Material 3) |
50+
| API Client | Ktor |
51+
| Dependency Injection | Koin |
52+
| Serialization | kotlinx.serialization |
53+
| Git Operations | ProcessBuilder (`git clone`) |
54+
| Logging | kermit |
55+
| Platform | Kotlin Multiplatform (JVM / Desktop) |
56+
57+
58+
### 🧩 Build and Run Desktop (JVM) Application
59+
60+
To build and run the development version of the desktop app, use the run configuration from the run widget in your IDE’s toolbar or run it directly from the terminal:
1661
- on macOS/Linux
1762
```shell
1863
./gradlew :composeApp:run
@@ -21,7 +66,55 @@ in your IDE’s toolbar or run it directly from the terminal:
2166
```shell
2267
.\gradlew.bat :composeApp:run
2368
```
69+
---
70+
71+
### 🎯 Next Goals
72+
73+
Here’s what’s coming next for Git Backup Hub 👇
74+
75+
- 🗂️ Backup History Panel — View previous backups with timestamps and file sizes.
76+
- 🔔 Desktop Notifications — Get notified when a backup finishes or encounters an error.
77+
- 🕒 Scheduled Backups — Automatically schedule daily or weekly backups.
2478

2579
---
80+
## Contributing 🤝
81+
82+
Contributions, issues, and feature suggestions are always welcome! 🙌
83+
If you have ideas to make Git Backup Hub better, feel free to open a pull request or start a discussion.
84+
85+
---
86+
## Screenshots
87+
88+
### Dark Theme
89+
![Dark Theme Screenshot](screenshot/dark_img1.png)
90+
![Dark Theme Screenshot](screenshot/dark_img2.png)
91+
![Dark Theme Screenshot](screenshot/dark_img3.png)
92+
93+
### Light Theme
94+
![Light Theme Screenshot](screenshot/light_img1.png)
95+
![Light Theme Screenshot](screenshot/light_img2.png)
96+
![Light Theme Screenshot](screenshot/light_img3.png)
97+
98+
99+
## ❤ Show your support
100+
101+
Give a ⭐️ if this project helped you!
102+
103+
<a href="https://www.buymeacoffee.com/codingmeet" target="_blank">
104+
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="160">
105+
</a>
106+
107+
Your generosity is greatly appreciated! Thank you for supporting this project.
108+
109+
## Connect with me
110+
111+
[![](https://img.shields.io/badge/Youtube-red?style=for-the-badge&logo=youtube&logoColor=white)](https://youtube.com/@CodingMeet26?si=FuKwU-aBaf_5kukR)
112+
[![](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/coding-meet-a74933273/)
113+
[![](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/CodingMeet)
114+
115+
## Author
116+
117+
**Meet**
118+
26119

27-
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…
120+
> 💬 _“Secure and sync all your Git repositories — effortlessly.”_

0 commit comments

Comments
 (0)