Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/warmachine028/github-super-starter-kit

Starter template repository with working GitHub actions for bootstrapping a new Project on GitHub.
https://github.com/warmachine028/github-super-starter-kit

git github github-actions github-workflow readme-profile readme-template starter-template template template-repository

Last synced: 4 days ago
JSON representation

Starter template repository with working GitHub actions for bootstrapping a new Project on GitHub.

Host: GitHub
URL: https://github.com/warmachine028/github-super-starter-kit
Owner: warmachine028
License: mit
Created: 2023-05-09T19:19:36.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-15T17:07:46.000Z (about 2 months ago)
Last Synced: 2024-09-15T18:28:50.365Z (about 2 months ago)
Topics: git, github, github-actions, github-workflow, readme-profile, readme-template, starter-template, template, template-repository
Homepage:
Size: 10.6 MB
Stars: 5
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

            updated on: 22nd September 2024, Sunday



    

        

    

     A good one liner description here 

    

        

    



# [Github Super Starter Kit](https://github.com/warmachine028/github-super-starter-kit)

![line]

## Table of Contents

- [Introduction](#introduction)

- [Getting Started](#getting-started)

- [Developement](#developement)

- [Tech Stack Used](#tech-stack-used)

- [Preview](#preview)

- [Best Contributors](#best-contributors)

- [License](#license)

![line]

## Introduction

- A github template to automate basic initial workflows of a project.

## Getting Started

### Generating a repo from the template

1. To configure automatic preview generation, replace [`url`](.github/take-snapshot.mjs#L5) with your hosted URL.

2. Configure the [CodeQL Analysis](.github/workflows/codeql-analysis.yml) according to your tech stack/language.

3. Configure [Dependabot](https://github.com/dependabot) alerts for package auto-updates and PRs for the package-manager of your choice inside [.github/dependabot.yml](.github/dependabot.yml)

4. Configure the directories and cron jobs of the package managers _(eg. client/server)_ inside [.github/dependabot.yml](.github/dependabot.yml).

5. By default **Dependabot Alerts** are enabled for npm only, the ones relevant to your project.

6. Feel free to add your own sections _(eg. Configuring, Designs, Documents, Diagrams)_ in this readme according to your requirements, make sure to link those sections in the above [**Table of Contents**](#table-of-contents)

7. You can find some free url-resourses below to find [markdown-badges], [icons] etc.

### Forking this template

- Run Initializer Action

1. Go to **Actions** tab

2. Enable workflows by Clicking on **green button** which says `I understand my workflows, go ahead and enable them`.

3. Click on `🍴 Fork initialize` from Actions Sidebar.

4. Click on `Run Workflow` in the **main** branch.

5. Go to **Security** tab

- Enable Dependabot Alerts

1. Wait for the Run Initializer above step to complete.

2. Go to [**Security**](https://github.com/warmachine028/github-super-starter-kit/security) tab.

3. Click on **Security Overview**.

4. Click on `Enable Dependabot alerts` button.

- Enable Code Scanning Alerts

1. Go to [Code security and analysis](https://github.com/SrijaAdhya12/github-super-starter-kit/settings/security_analysis#code_scanning_settings) section in settings.

2. Enable subsequent **Graphs**, **updates** and **alerts**.

3. Scroll down and go to **Tools** section set `CodeQL Analysis` to default.

![line]

## Developement

- Steps used for development of this project

- Build processes

- CI/CD commands

- Docker commands

![line]

## Tech Stack Used

- GitHub

- Markdown

- Prettier

- Dependabot

- GitHub Actions

- Yaml

- JavaScript

![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white) ![Markdown](https://img.shields.io/badge/markdown-%23000000.svg?style=for-the-badge&logo=markdown&logoColor=white) ![Prettier](https://img.shields.io/badge/prettier-1A2B34?style=for-the-badge&logo=prettier&logoColor=pink) ![Dependabot](https://img.shields.io/badge/dependabot-025E8C?style=for-the-badge&logo=dependabot&logoColor=white) ![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white) ![YAML](https://img.shields.io/badge/yaml-%23ffffff.svg?style=for-the-badge&logo=yaml&logoColor=151515) ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

![line]

## Preview

    

    

    

![line]

## Best Contributors



    

        

    



![line]

## License

- See [LICENSE]

**Pritam Kundu, 2024**

![line]

## Thank you, everyone 💚

[icons]: https://icons8.com

[markdown-badges]: https://github.com/Ileriayo/markdown-badges

[custom-icons]: https://simpleicons.org

[line]: https://user-images.githubusercontent.com/75939390/137615281-3a875960-92cc-407f-97fe-fd2319bdb252.png

[License]: https://github.com/warmachine028/github-super-starter-kit/blob/main/LICENSE