https://github.com/gftf2011/url-shortener
TinyURL Backend CLONE made with Nest.Js, built with Clean Architecture using Design Patterns and D.D.D. that runs in REST a server
https://github.com/gftf2011/url-shortener
cache clean-architecture clean-code cqs design-patterns docker docker-compose dockerfile javascript mysql nestjs nodejs redis rest rest-api typescript
Last synced: 4 months ago
JSON representation
TinyURL Backend CLONE made with Nest.Js, built with Clean Architecture using Design Patterns and D.D.D. that runs in REST a server
- Host: GitHub
- URL: https://github.com/gftf2011/url-shortener
- Owner: gftf2011
- License: mit
- Created: 2024-06-21T22:23:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-23T18:25:45.000Z (9 months ago)
- Last Synced: 2025-04-23T19:38:04.582Z (9 months ago)
- Topics: cache, clean-architecture, clean-code, cqs, design-patterns, docker, docker-compose, dockerfile, javascript, mysql, nestjs, nodejs, redis, rest, rest-api, typescript
- Language: TypeScript
- Homepage: https://github.com/gftf2011
- Size: 293 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CLEAN Nest.JS URL-SHORTNER
A progressive Node.js framework for building efficient and scalable server-side applications.
About •
Supported OS •
Design Patterns •
Principles •
Business Rules •
ADRs •
Required Tools •
Running Project •
Running Tests •
License
## :page_facing_up: About
This a backend APP from a URL-SHORTENER Nest.JS typescript project.
It is a study project used to see how would be implemented a incremental version of a URL-SHORTENER.
The best approach for this problem it is not this one presented, again it is just a study repo !
To see an implementation using the incremental version see the branch "incremental-short-url".
To see an implementation using the incremental version, with sync data replication, see the branch "dev", W.I.P. (Work In Progress)
The objective from this project was to explore the framework by creating a well defined set of APIs with a decoupled architecture using Clean Architecture and D.D.D. - (Domain Driven Design) and exploring architecture capabilities like caching and design capabilities with several design patterns.
## :hammer_and_wrench: Supported OS
- [x] Mac OS
- [x] Linux
- [x] Windows - WSL
## :large_blue_diamond: Design Patterns
### Creational
- [Factory Method](https://refactoring.guru/design-patterns/factory-method)
- [Singleton](https://refactoring.guru/design-patterns/singleton)
### Structural
- [Adapter](https://refactoring.guru/design-patterns/adapter)
- [Decorator](https://refactoring.guru/design-patterns/decorator)
- [Proxy](https://refactoring.guru/design-patterns/proxy)
## :blue_book: Principles
- [Single Responsibility Principle (SRP)](https://en.wikipedia.org/wiki/Single-responsibility_principle)
- [Open Closed Principle (OCP)](https://en.wikipedia.org/wiki/Open%E2%80%93closed_principle)
- [Liskov Substitution Principle (LSP)](https://en.wikipedia.org/wiki/Liskov_substitution_principle)
- [Interface Segregation Principle (ISP)](https://en.wikipedia.org/wiki/Interface_segregation_principle)
- [Dependency Inversion Principle (DIP)](https://en.wikipedia.org/wiki/Dependency_inversion_principle)
- [Separation of Concerns (SOC)](https://en.wikipedia.org/wiki/Separation_of_concerns)
- [Don't Repeat Yourself (DRY)](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
- [You Aren't Gonna Need It (YAGNI)](https://en.wikipedia.org/wiki/You_aren%27t_gonna_need_it)
- [Keep It Simple, Stupid (KISS)](https://en.wikipedia.org/wiki/KISS_principle)
- [Composition Over Inheritance](https://en.wikipedia.org/wiki/Composition_over_inheritance)
## :building_construction: Business Rules
- **Clients**
- [Create Account](https://github.com/gftf2011/url-shrtener/tree/main/docs/requirements/clients/create-account.md)
- [Login](https://github.com/gftf2011/url-shrtener/tree/main/docs/requirements/clients/login.md)
- **Short URLs**
- [Redirect](https://github.com/gftf2011/url-shrtener/tree/main/docs/requirements/short-urls/redirect.md)
- [Create Short URL](https://github.com/gftf2011/url-shrtener/tree/main/docs/requirements/short-urls/create-short-url.md)
- [Delete Short URL](https://github.com/gftf2011/url-shrtener/tree/main/docs/requirements/short-urls/delete-short-url.md)
## :orange_book: ADRs - Architecture Decision Records
- ['Short URL' ID Definition](https://github.com/gftf2011/url-shortener/tree/main/docs/ADRs/short-url-id-definition.md)
- [Soft Delete](https://github.com/gftf2011/url-shortener/tree/main/docs/ADRs/soft-delete.md)
- [MySQL Core Databse](https://github.com/gftf2011/url-shortener/tree/main/docs/ADRs/mysql-core-database.md)
- [LRU Cache](https://github.com/gftf2011/url-shortener/tree/main/docs/ADRs/lru-cache.md)
## :clipboard: Required Tools
- [x] Nest - [http://nestjs.com/](http://nestjs.com/)
- Nest version: 10.3.2
- [x] Node - [https://nodejs.org/](https://nodejs.org/)
- Node version: 20.11.0
- npm version: 10.2.x
- [x] Docker - [https://www.docker.com/](https://www.docker.com/)
## :racing_car: Running Project
**DEVELOPMENT**
```sh
$ npm i
$ npm run start:dev
```
**DEBUG**
```sh
$ npm i
$ npm run start:debug
```
OBS.: After the server is UP and Running use __api.http__ file to do your requests using **VS Code**
## :test_tube: Running Tests
> ### Full Test
```sh
$ npm run test
```
## :memo: License
This project is under MIT license. See the [LICENSE](https://github.com/gftf2011/url-shortener/blob/main/LICENSE) file for more details.
---
Made with lots of :heart: by [Gabriel Ferrari Tarallo Ferraz](https://www.linkedin.com/in/gabriel-ferrari-tarallo-ferraz/)