README.md

updated on: 22nd September 2024, Sunday

A good one liner description here

Github Super Starter Kit

Table of Contents

• Introduction
• Getting Started
• Developement
• Tech Stack Used
• Preview
• Best Contributors
• License

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 with your hosted URL.
2. Configure the CodeQL Analysis according to your tech stack/language.
3. Configure Dependabot alerts for package auto-updates and PRs for the package-manager of your choice inside .github/dependabot.yml
4. Configure the directories and cron jobs of the package managers (eg. client/server) inside .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
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 tab.
3. Click on Security Overview.
4. Click on Enable Dependabot alerts button.

• Enable Code Scanning Alerts

1. Go to Code security and analysis section in settings.
2. Enable subsequent Graphs, updates and alerts.
3. Scroll down and go to Tools section set CodeQL Analysis to default.

Developement

• Steps used for development of this project
• Build processes
• CI/CD commands
• Docker commands

Tech Stack Used

• GitHub
• Markdown
• Prettier
• Dependabot
• GitHub Actions
• Yaml
• JavaScript

Preview

Best Contributors

License

• See LICENSE

Pritam Kundu, 2024

Thank you, everyone 💚