https://github.com/theelegantcoding/git_hook

⚙️comprehensive set of git hooks designed to streamline your development workflow, automate routine tasks, and ensure code quality. This powerful suite empowers you to maintain a consistent and organized development environment, enhancing productivity and reducing the risk of errors.
https://github.com/theelegantcoding/git_hook

bash changelog-generator clean-architecture clean-code commitlint design-pattern git git-hook github performance

Last synced: 7 months ago
JSON representation

Host: GitHub
URL: https://github.com/theelegantcoding/git_hook
Owner: TheElegantCoding
Created: 2023-08-14T22:53:05.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-02-04T20:37:18.000Z (almost 2 years ago)
Last Synced: 2025-03-19T17:53:47.594Z (10 months ago)
Topics: bash, changelog-generator, clean-architecture, clean-code, commitlint, design-pattern, git, git-hook, github, performance
Language: Shell
Homepage:
Size: 563 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: .github/readme.md

Awesome Lists containing this project

README

edge

📦️ Astro template webpage

---

📝 About

Tired of sluggish websites and SEO headaches? Unleash the power of lightning-fast performance and built-in optimization with this Astro template builder! Crafted for developers who value speed and simplicity, this robust toolkit empowers you to build stunning websites that soar in search engines and captivate users.

Ditch the struggle and focus on what matters most - crafting impactful content that drives engagement. Welcome to the future of web development - where SEO and performance work hand-in-hand.

(⬆️ back to top)

---

## 📚 Table of content

- [📝 About](#about)
- [🛰️ Features](#features)
- [⚡️ Requirements](#requirements)
- [📦 Installation](#installation)
- [⚙️ Configuration](#configuration)
- [🚀 Usage](#usage)
- [⚡️ Scripts](#scripts)
- [🌎 Browser support](#browser-support)

---

🛰️ Features

- `🌌 Astro` - Astro Framework
- `🦾 Typescript` - Extremely strict type checking
- `✅ Absolute imports` - No more bad imports
- `💎 Sass` - Css framework for ui development
- `✅ BEMIT` - Arquitecture for sass
- `✅ Mobile firts` - Best performance for css
- `✅ Reset` - Reset css for match style between browsers
- `✅ Join media queries` - Join media queries for small file size
- `✅ Vendor prefixes` - Vendor prefixes for all support
- `✅ Remove unused css` - Remove unused css in build
- `🏗️ Clean arquitecture` - For clean code and scalablility
- `🌎 SEO` - SEO meta data, open graph and more
- `✅ Sitemap` - Sitemap generator
- `✅ RSS` - RSS generator
- `✅ ️Robot` - Robot txt configuration
- `✅ Canonical` - Auto canonical url
- `✅ Google analytincs` - For positioning the webpage
- `📐 Linter` - Linter and formatting all kind of files
- `✅ Eslint` - Litner and formatting ts and js files
- `✅ Stylelint` - Linter css files
- `🕹️ Git` - Control version and more
- `✅ Github issue template` - Github issues organization
- `✅ Githooks` - Git hook for validate code quality
- `✅ Changelog` - Changelog and realese for github
- `✅ Sematic release` - Automatization of releases
- `⚙️ Confugiration` - Vscode, env variables and more
- `✅ Vscode configuration` - Vscode recommendations, extensions and more
- `✅ Env validation` - Enviroment variables validation
- `🧩 Components`
- `✅ Image component` - Ready to use optimize image component
- `✅ Show component` - Ready to use show component
- `✅ For component` - Ready to use show
- `️⚡️ Performance`
- `✅ Bundler analizer` - Analize your bundle size
- `✅ Compress` - Compress images, font, css, js, and html
- `✅ Non blocking` - Non blocking js, css and more
- `✅ Font optimization` - Font transformation and declaration
- `📦 Pnpm` - Fast package manager
- `💯 Perfect lighthouse score` - Because performance matters

---

⚡️ Requirements

- node >= **20.10.0**
- git >= **2.38**
- pnpm >= **8.2.0**

(back to top)

---

📦 Installation

After cloning the repo run this command to install all the dependencies

```bash
pnpm install
```

(back to top)

---

⚙️ Configuration

The configuration needed for this project is to set up the env variables here are the examples:

file: **.example.dev.env**

```yml
VITE_PORT=3000
VITE_BASE_URL=http://localhost:$VITE_PORT
```

file: **.example.prod.env**

```yml
VITE_BASE_URL=
```

file: **.example.staging.env**

```yml
VITE_PORT=4173
VITE_BASE_URL=http://localhost:$VITE_PORT
```

(back to top)

---

🚀 Usage

Before installing all the dependencies you can run the project with

```bash
pnpm dev
```

To see the production ready page you can run

```bash
pnpm staging
```

Builds the app for production to the `dist` folder.

It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes, also it compress all the assets and images in the dist folder.

Your app is ready to be deployed.

(back to top)

---

⚡️ Scripts

The following scripts are available in the `package.json`:

- `preinstall`: This script is for only allow pnpm as package manager
- `postinstall`: This script is for setting up the git hooks and validate the error after commit to github
- `dev`: This script is for see the webpage in dev mode
- `staging`: This script is for see production, this run the env variables an set the webpage with all the settings
- `build-dev`: This script compile the project in dev mode
- `build`: This script is for build in production
- `lint`: This script is for format and lint all the files
- `lint-eslint`: This script is for lint ts, tsx and more files
- `lint-stylelint`: This script is for lint css files

(back to top)

---