Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ScottKirvan authored Jan 9, 2025
0 parents commit 681a345
Show file tree
Hide file tree
Showing 15 changed files with 734 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

github: ScottKirvan # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
3 changes: 3 additions & 0 deletions .github/release-please/.release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "1.0.0"
}
13 changes: 13 additions & 0 deletions .github/release-please/release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"release-type": "simple",
"include-component-in-tag": false,
"changelog-path": "notes/CHANGELOG.md",
"packages": {
".": {
"extra-files": [
"notes/VERSION.md"
]
}
}
}
31 changes: 31 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Release Workflow

on:
push:
branches:
- main

permissions:
contents: write
pull-requests: write

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: googleapis/release-please-action@v4
id: release
with:
# this assumes that you have created a personal access token
# (PAT) and configured it as a GitHub action secret named
# `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
# token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ github.token }}
config-file: .github/release-please/release-please-config.json
manifest-file: .github/release-please/.release-please-manifest.json
# this is a built-in strategy in release-please, see "Action Inputs"
# for more options
# release-type: simple



2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ScooterGitTemplate.code-workspace
.obsidian/*
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Scott Kirvan

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.
111 changes: 111 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<div align="center">

<img src="assets/media/logo.jpg" alt="logo" width="200" height="auto" />
<h1><a href="https://github.com/ScottKirvan/ScooterGitTemplate">ScottKirvan/ScooterGitTemplate</a></h1>
<h3>Nulla nobis dicta iste minus dolor repellendus aspernatur atque</h3>


<!-- Badges -->
<p>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/graphs/contributors">
<img src="https://img.shields.io/github/contributors/ScottKirvan/ScooterGitTemplate" alt="contributors" />
</a>
<a href="">
<img src="https://img.shields.io/github/last-commit/ScottKirvan/ScooterGitTemplate" alt="last update" />
</a>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/network/members">
<img src="https://img.shields.io/github/forks/ScottKirvan/ScooterGitTemplate" alt="forks" />
</a>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/stargazers">
<img src="https://img.shields.io/github/stars/ScottKirvan/ScooterGitTemplate" alt="stars" />
</a>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/issues/">
<img src="https://img.shields.io/github/issues/ScottKirvan/ScooterGitTemplate" alt="open issues" />
</a>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/ScottKirvan/ScooterGitTemplate.svg" alt="license" />
</a>
<a href="https://discord.gg/gQH4mXWQRT">
<!--<img src="https://img.shields.io/discord/704680098577514527?style=flat-square&label=%F0%9F%92%AC%20discord&color=00ACD7">-->
<img src="https://img.shields.io/discord/1052011377415438346?style=flat-square&label=discord&color=00ACD7">
</a>
</p>

<h4>
<a href="https://tinyurl.com/3vf7whyd">View Demo</a>
<span> · </span>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/blob/main/README.md">Documentation</a>
<span> · </span>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/issues/new?labels=bug&title=%5BBUG%5D">Report Bug</a>
<span> · </span>
<a href="https://github.com/ScottKirvan/ScooterGitTemplate/issues/new?labels=enhancement&title=%5BFEATURE+REQUEST%5D">Request Feature</a>
</h4>
</div>

**ScooterGitTemplate** is voluptatibus magni nemo est. Nulla nobis dicta iste minus dolor repellendus aspernatur atque. Earum expedita aut inventore tempora fugiat deleniti. Molestias minima nam expedita beatae totam ipsa reprehenderit animi. Occaecati quibusdam beatae ducimus voluptate ut doloribus vitae amet. Quia ut ut voluptate dignissimos adipisci dolorum rem.

Branches
--------
`main` is the [deployed](https://www.scottkirvan.com/ScooterGitTemplate/) branch. The repo doesn't currently contain any other historic or dev branches.

Repo Layout
-----------
```
ScooterGitTemplate
├───_layouts
├───.github
│ ├───release-please
│ └───workflows
├───assets
│ ├───css
│ └───media
└───notes
```
The `_layouts` and `assets/css` folders help support the look of the repo when rended to GitHub Pages (Deployment Workflow).
You can see an example of this repo processed using Jekyll and published at [ScottKirvan.com](https://www.scottkirvan.com/ScooterGitTemplate/). You have to enable **Pages** in your repo's settings. Details [here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll).

The css file creates a page that is styled similar to GitHub's [Dark High Contrast](https://github.blog/changelog/2021-08-25-dark-high-contrast-theme-ga/) theme.

The files in the `.github` folder implement and customizes a github action that runs [Release-Please](https://github.com/googleapis/release-please), which helps with releases, version numbering, and updating the [CHANGELOG](notes/CHANGELOG.md).

>[!NOTE]
> When using this template project, do not clone the tags or branches. Stick with `main` as the name of your main release branch. Change the version number in the `.release-please-manifest.json` file to the version you want to start with.
>
> Release-Please uses [Semantic Versioning](https://semver.org/) (version: MAJOR.MINOR.PATCH). Changes to version numbers are triggered by specific keywords in your commit messages:
> - `feat:` (new feature) will bump the MINOR version number.
> - `fix:` (bug fixes) will bump the PATCH number.
> - `feat!:` `fix!:` or any `xxx!:` (major and breaking changes) will bump the MAJOR version number.


Table of Contents
-----------------
- [Branches](#branches)
- [Repo Layout](#repo-layout)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributions / Contact](#contributions--contact)
- [Credits](#credits)

Features
--------
Installation
------------
Usage
-----

Contributions / Contact
-----------------------
- Please [file an issue](https://github.com/ScottKirvan/ScooterGitTemplate/issues/new), or [grab a fork](https://github.com/ScottKirvan/ScooterGitTemplate/fork), hack away, and submit a [pull request](https://github.com/ScottKirvan/ScooterGitTemplate/pulls).
- Contact me at [linkedin.com/in/scottkirvan/](https://www.linkedin.com/in/scottkirvan/)
- You can also contact me at my [discord](https://discord.gg/TSKHvVFYxB) server, I'm cptvideo.

Credits
-------
**Copyright (c) (2024):** [Scott Kirvan](https://github.com/ScottKirvan) - All rights reserved
*ScooterGitTemplate is licensed under the [MIT License](LICENSE.md).*

Project Link: [ScooterGitTemplate](https://github.com/ScottKirvan/ScooterGitTemplate)
[CHANGELOG](notes/CHANGELOG.md)
[TODO](notes/TODO.md)
8 changes: 8 additions & 0 deletions ScooterGitTemplate.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"folders": [
{
"path": "."
}
],
"settings": {}
}
19 changes: 19 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- _layouts/default.html -->
<!DOCTYPE html>
<html>

<head>
<meta charset="UTF-8">
<title>{{ page.title }}</title>
<link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/assets/css/custom.css">
</head>

<body>
<div class="MainBody">
{{ content }}
</div> <!-- MainBody -->
<div class="footer">
</div> <!-- footer -->
</body>

</html>
Loading

0 comments on commit 681a345

Please sign in to comment.