Skip to content

Commit 0c158f8

Browse files
committed
go init
1 parent 4ca51d3 commit 0c158f8

24 files changed

+2219
-244
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ First off, thanks for taking the time to contribute!
22

33
## Please Complete the Following
44

5-
- [ ] I read [CONTRIBUTING.md](https://github.com/Cyclenerd/template/blob/master/CONTRIBUTING.md)
5+
- [ ] I read [CONTRIBUTING.md](https://github.com/Cyclenerd/offline-map-tile-downloader/blob/master/CONTRIBUTING.md)
66

77
## Notes
88

.github/dependabot.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ updates:
44
directory: "/"
55
schedule:
66
interval: "weekly"
7+
- package-ecosystem: "gomod"
8+
directory: "/"
9+
schedule:
10+
interval: "weekly"

.github/workflows/ci.yml

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: "CI"
1+
name: CI
22

33
on:
44
push:
@@ -7,25 +7,23 @@ on:
77

88
jobs:
99
test:
10-
name: CI/CD Test
10+
name: Test
1111
# https://github.com/actions/virtual-environments/
1212
runs-on: ubuntu-latest
1313
steps:
14-
1514
- name: 🛎️ Checkout
1615
uses: actions/checkout@v5
1716

18-
# Test
19-
- name: 🌡️ Test
20-
run: uname -a
17+
# https://github.com/marketplace/actions/setup-go-environment
18+
- name: 🔧 Setup go
19+
uses: actions/setup-go@v5
2120

22-
# Test Linux operating systems
23-
- name: 🐧 Test Debian 11 (Bullseye)
24-
run: |
25-
docker pull debian:11
26-
docker run -v $PWD:/temp/test debian:11 uname -a
21+
# https://github.com/marketplace/actions/run-golangci-lint
22+
- name: 🌡️ Lint
23+
uses: golangci/golangci-lint-action@v8
2724

28-
- name: 🐧 Test Rocky Linux 8
29-
run: |
30-
docker pull rockylinux:8
31-
docker run -v $PWD:/temp/test rockylinux:8 uname -a
25+
- name: 🍳 Build
26+
run: make native
27+
28+
- name: 🌡️ Test
29+
run: ./offline-map-tile-downloader --help

.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
offline-map-tile-downloader*
8+
9+
# Test binary, built with `go test -c`
10+
*.test
11+
12+
# Output of the go coverage tool, specifically when run with the
13+
# -o option to specify an output file.
14+
*.out
15+
16+
# Dependency directories (remove the comment below if you do not vendor)
17+
# vendor/
18+
19+
# Go workspace file
20+
go.work
21+
22+
# Log files
23+
*.log
24+
25+
# OS-specific files
26+
.DS_Store
27+
28+
# Tile cache
29+
maps/

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ in your GitHub account.
2424
Clone your newly created fork of the repository to your local machine with the following command:
2525

2626
```bash
27-
git clone https://github.com/your-username/template.git
27+
git clone https://github.com/your-username/offline-map-tile-downloader.git
2828
```
2929

3030
## Create a New Branch 🌿
@@ -37,6 +37,7 @@ git checkout -b "feature-or-issue-name"
3737
```
3838

3939
## Submitting Changes 🚀
40+
4041
Make your desired changes to the codebase.
4142

4243
Stage your changes using the following command:
@@ -58,12 +59,20 @@ This will open a new pull request to the original repository.
5859

5960
## Coding Style 📝
6061

61-
Start reading the code, and you'll get the hang of it. It is optimized for readability:
62+
This project follows standard Go coding conventions. Before submitting your changes, please ensure that your code is formatted with `gofmt`.
63+
64+
Most editors for Go will format your code automatically on save. You can also run `gofmt` manually:
65+
66+
```bash
67+
gofmt -w .
68+
```
69+
70+
In addition to `gofmt`, please follow these guidelines:
6271

63-
- Variables must be uppercase and should begin with `MY_`.
64-
- Functions must be lowercase.
65-
- Check your shell scripts with ShellCheck before submitting.
66-
- Please use tabs to indent.
72+
- Write clear and concise comments where necessary.
73+
- Follow the naming conventions established in the existing code.
74+
- Keep functions and methods short and focused on a single task.
75+
- Handle errors explicitly and avoid panicking.
6776

6877
## Keep It Simple 👍
6978

LICENSE

Lines changed: 21 additions & 201 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,21 @@
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 [yyyy] [name of copyright owner]
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.
1+
MIT License
2+
3+
Copyright (c) 2025 Matthew Drummonds
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Makefile

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Name of the binary output
2+
BINARY = offline-map-tile-downloader
3+
4+
# Builds the project
5+
build: native linux macos windows
6+
7+
native:
8+
go build -o ${BINARY}
9+
@echo
10+
11+
linux:
12+
@echo "Linux"
13+
GOOS=linux GOARCH=amd64 go build -o ${BINARY}-linux-x86_64
14+
GOOS=linux GOARCH=arm64 go build -o ${BINARY}-linux-arm64
15+
@echo
16+
17+
macos:
18+
@echo "macOS"
19+
GOOS=darwin GOARCH=amd64 go build -o ${BINARY}-macos-x86_64
20+
GOOS=darwin GOARCH=arm64 go build -o ${BINARY}-macos-arm64
21+
@echo
22+
23+
windows:
24+
@echo "Windows"
25+
GOOS=windows GOARCH=amd64 go build -o ${BINARY}-windows-x86_64.exe
26+
GOOS=windows GOARCH=arm64 go build -o ${BINARY}-windows-arm64.exe
27+
@echo
28+
29+
# Clean the project: deletes binaries
30+
clean:
31+
if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi
32+
if [ -f ${BINARY}-linux-x86_64 ] ; then rm ${BINARY}-linux-x86_64 ; fi
33+
if [ -f ${BINARY}-linux-arm64 ] ; then rm ${BINARY}-linux-arm64 ; fi
34+
if [ -f ${BINARY}-macos-x86_64 ] ; then rm ${BINARY}-macos-x86_64 ; fi
35+
if [ -f ${BINARY}-macos-arm64 ] ; then rm ${BINARY}-macos-arm64 ; fi
36+
if [ -f ${BINARY}-windows-x86_64.exe ] ; then rm ${BINARY}-windows-x86_64.exe ; fi
37+
if [ -f ${BINARY}-windows-arm64.exe ] ; then rm ${BINARY}-windows-arm64.exe ; fi

0 commit comments

Comments
 (0)