A realistic approach to implement clean architecture on react codebases
This is an example repo, I wouldn't do exactly like this in production. I am just share one way this could be done, may not be the best, but it's a realistic way. I Recommend looking for other implementations as well to complement your research. The repo is also a bit outdated and many conventions have changed over time.
Applying clean architecture to a react codebase brings lots of benefits, most of them you can find by simply googling what's clean architecture and what should we adopt architectural patterns.
One advantage that strikes me is having business rules isolated from framework-specific things. This means that our core logic is not coupled to React, React Native, Express, etc...
This gives you enough flexibility to, for example, move specific parts of the application to a backend, change libraries without too much pain, test once and reuse as many times as you want, share code between React and React Native applications, among others.
This is a realistic approach, what I mean by that is: It's simple enough to be applicable and Robust enough to have it in a production environment. Although I have greatly simplified it, for educational purposes, I believe that this example is of great value to get you started with applying architectural patterns and adapting them to your own needs.
I've been pretty busy lately, so I'll write as much as possible.
I'll write three blog posts explaining better what is Clean Architecture, why adopt it and how. Portuguese version of How to implement clean architecture for React codebases can be found HERE
The nomenclature may vary, but the concept behind this architectural pattern is: the domain dictates how tools should be organized and not the other way around. What I mean by that is that we should organize our codebase around the business rules and not around the frameworks we use to achieve business rules. The diagram above shows how the dependency rule works, the inner circles must not know about the outer circles. That is, there cannot be an import of a use case within an entity, or import of a framework within a use case. Another important rule is: entities and use cases should not rely on external libraries. The explanation is simple, the core of our application must be robust enough and malleable enough to meet the demands of the business without needing any external intervention. If by chance, an essential part of the application core MUST BE an external dependency. Dependency needs to be modeled following dependency inversion principle.
Talk is cheap, don't you think? That's why I'm sharing two sample apps to facilitate your digestion.
A great advantage of following clean architecture is having all business logic self-contained and closer, in a readable way.
Take a look at
core/useCases/folders and see for yourself.
The counter app is a simple example of how to apply clean architecture to react world, it uses only synchronous actions and has no external dependencies.
It contains 2 use case rules: - The count must not be negative. - The count must not be greater than 10.
An authentication app is a simple example, but not that simple, of how to apply clean architecture to a realistic scenario. It contains some shared business rules: - Users must have a valid email. - Users password must comprises only numbers and/or letters. - Users name must have a full name, and it must to be lowercased. - The App cannot sign up two users with the same email address. - The App must use an external dependency to persist user register.
This repository contains 2 examples of how to implement react following clean architecture, represented by the diagram above, and both follow the same folder structure:
./counter ├── core │ └── lib │ ├── adapters │ │ └── redux │ ├── entities │ ├── frameworks │ └── useCases ├── native │ └── src │ ├── components │ └── stylesheets └── web └── src ├── assets ├── components └── stylesheetsNote: the
frameworksfolder comprises framework-specific setups to have it available to the adapters.
npm installunder the project you'd like to run, and then run
There's an issue related to how yarn/npm symlink file dependencies on windows. Due to this issue, you should first go under the
coremodule and run
npm run build. This will make the
coremodule ready to be installed on the other modules.
If something looks odd, don't hesitate to reach me out or opening an issue.