Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deverebor/typescript-design-patterns-study
Playground for studying design patterns, solid principles, GoF, testing and more with TypeScript
https://github.com/deverebor/typescript-design-patterns-study
design-patterns gof-patterns jest solid-principles typescript unit-testing
Last synced: about 2 hours ago
JSON representation
Playground for studying design patterns, solid principles, GoF, testing and more with TypeScript
- Host: GitHub
- URL: https://github.com/deverebor/typescript-design-patterns-study
- Owner: deverebor
- Created: 2022-07-03T13:55:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-09-22T20:23:06.000Z (about 2 years ago)
- Last Synced: 2023-03-03T23:23:11.758Z (over 1 year ago)
- Topics: design-patterns, gof-patterns, jest, solid-principles, typescript, unit-testing
- Language: TypeScript
- Homepage:
- Size: 389 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript design patterns study
> Playground for studying design patterns, solid principles, GoF, testing and more with TypeScript
## Index
- [TypeScript design patterns study](#typescript-design-patterns-study)
- [Index](#index)
- [Introduction](#introduction)
- [Folder structure](#folder-structure)
- [Running App](#running-app)
- [Using the project](#using-the-project)
- [SOLID](#solid)
- [TestPratice](#testpratice)
- [GoF](#gof)
### Introduction
This repo has been created to study design patterns, solid principles, GoF, testing and more with TypeScript.
#### Folder structure
All topics are in the `src` folder, separated by they topic. All topic has an `README.md` file and his sub topics as well.
### Running App
To install follow these steps:
> Clone the repo
```zsh
git clone [email protected]:deverebor/typescript-design-patterns-study.git
```
> Enter the repo directory
```zsh
cd typescript-design-patterns-study
```
> Install the dependencies
```zsh
npm i
```
### Using the project
Follow these steps:
#### [SOLID](src/SOLID/)
- npm run start:srp - single responsibility principle
- npm run start:ocp - open closed principle
- npm run start:lsp - liskov substitution principle
- npm run start:isp - interface segregation principle
- npm run start:dip - dependency inversion principle
- npm run start:legacy
#### [TestPratice](src/TestPratice/)
- npm run test - test the project
- npm run test:silent - silent with watch test
- npm run test:coverage - to generate coverage report
#### [GoF](src/GOF/)
- creational
- [Singleton](src/GOF/creational/singleton/) - npm run creational:singleton
- [Builder](src/GOF/creational/builder/) - npm run creational:builder
- [ProtoType](src/GOF/creational/prototype/)
- npm run creational:proto-deep - Deep Clone
- npm run creational:proto-shallow - Shallow Clone
- npm run creational:proto-js-obj - JS Object Clone
- npm run creational:proto-js-func - JS Function Clone
- [FactoryMethod](src/GOF/creational/factory-method/) - npm run creational:factory
- [AbstractFactory](src/GOF/creational/abstract-factory/) - npm run creational:abstract-factory
- structural
- [Composite](src/GOF/structural/composite/)
- npm run structural:composite-classic - Classic Structure
- npm run structural:composite-validation - Validation Structure
- [Adapter](src/GOF/structural/adapter/) - npm run structural:adapter
- [Bridge](src/GOF/structural/bridge/) - npm run structural:bridge
- [Decorator](src/GOF/structural/decorator/) - npm run structural:decorator
- [Facade](src/GOF/structural/facade/) - npm run structural:facade
- [Proxy](src/GOF/structural/proxy/) - npm run structural:proxy
- [Flyweight](src/GOF/structural/flyweight/) - npm run structural:flyweight
- behavioral
- [Strategy](src/GOF/behavioral/strategy/) - npm run behavioral:strategy
- [Command](src/GOF/behavioral/command/) - npm run behavioral:command
- [Memento](src/GOF/behavioral/memento/) - npm run behavioral:memento
- [State](src/GOF/behavioral/state/) - npm run behavioral:state
- [Mediator](src/GOF/behavioral/mediator/) - npm run behavioral:mediator
> Initialize the project you want
```zsh
npm run start:dip
```
---
Developer with ❤️🔥 by Lucas Souza (@deverebor)