Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 2.51 KB

README.md

File metadata and controls

48 lines (38 loc) · 2.51 KB

typescript-oop-clean-architecture

My first TypeScript project using the object-oriented programming paradigm and clean architecture. Much of what was developed here was meant to deconstruct the way I approach programming projects, where I would usually think about which programming language to use, the framework, the database, cloud services, and libraries. Much of this made me a hostage to them. In the end, we realize that these technologies only exist to solve a problem, and the problem is constantly changing, and there will always be a new one that requires a new solution to resolve it. In the end, we see that all the available technology is not enough, and that's when we sit in front of the computer and start developing a new solution to solve that problem.

I created this project to reflect on these points, taking me back to the beginning of when I started programming, back in 2019, when my teacher taught me how to program without using Java utilities or pre-existing libraries to solve problems.

Objective

To develop a desktop application, revisiting past concepts learned during my college years. These concepts include object-oriented programming, clean code, clean architecture, and many of them serve as an initial foundation to start shaping the business rules of projects before using a framework or technology.

Technologies

  • Javascript
  • Typescript
  • prompt-sync (a library to facilitate interaction with the command prompt)

Project Design

The project was developed using concepts of:

  • Object-oriented programming
  • Clean code
  • Clean architecture

Tutorial

Note: To follow the step-by-step instructions for running the application on your machine, you need to have knowledge of terminal commands, Git and GitHub commands, and npm package manager commands, as well as navigating between folders using the terminal.

Cloning and setting up the project

1º step: clone the repository to your machine from GitHub.

git clone https://github.com/Marlinsk/typescript-poo-clean-architecture.git

2º step: Navigate to the project folder.

cd typescript-poo-clean-architecture

3º step: Run the command in the terminal to install the project dependencies.

npm install

4º step: Execute the command to build the application.

npm run build

Without the dist file generated by the build, the application will not work.

5º step: Run the command in the terminal to start the application, and feel free to test and play around.

npm run start