https://github.com/albertobasalo/principles-and-patterns

Principles and patterns for a better code
https://github.com/albertobasalo/principles-and-patterns

Last synced: 19 days ago
JSON representation

Principles and patterns for a better code

• Host: GitHub
• URL: https://github.com/albertobasalo/principles-and-patterns
• Owner: AlbertoBasalo
• License: mit
• Archived: true
• Created: 2022-07-22T08:34:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-27T12:03:33.000Z (about 2 years ago)
• Last Synced: 2024-12-10T17:07:10.409Z (19 days ago)
• Language: TypeScript
• Size: 9.55 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Principles and Patterns

> Advanced clean code techniques for a better codebase.

```terminal

git clone https://github.com/AlbertoBasalo/principles-and-patterns.git 

cd principles-and-patterns

npm install

```

## 🎯 Motivation

- know the categories of code patterns

- know the principles for design patterns 

- know when and how to use them

## ⚙ Workflows

### 👨‍💻 Dev Workflow

While developing, make sure to install the recommended extensions for a better dev experience.

#### Updating

To keep your dependencies up to date use `npm run updates` and it will check for updates. Then cherry-pick what you want to update.

## 🛠 Tools

### 📋 GitHub Issues

Use GitHub issues for tracking _User Stories_ and _developer tasks_.

### 📦 Commits and release

- Use the [standard-version utility](https://www.npmjs.com/package/standard-version) to produce a changelog file from [Conventional Commits guides](https://www.conventionalcommits.org/en/v1.0.0/)

### 💅 Code style with Prettier

- Installed and configured the _PrettierExtension_

### 📐 Code linting with esLint

- Installed and configured _esLint_ to work with _Prettier_

> Recommended [esLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

## 🛠 VS Code

### 🧩 Extensions recommendations

- [Abracadabra, refactor this!](https://marketplace.visualstudio.com/items?itemName=nicoespeon.abracadabra)

- [Better Comments](https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments)

- [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)

- [esLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

- [IntelliCode](https://marketplace.visualstudio.com/items?itemName=VisualStudioExptTeam.vscodeintellicode)

- [Material Icon Theme](https://marketplace.visualstudio.com/items?itemName=PKief.material-icon-theme)

- [Path Intellisense](https://marketplace.visualstudio.com/items?itemName=christian-kohler.path-intellisense)

- [Prettier](https://github.com/prettier/prettier-vscode)

---

  
By Alberto Basalo