Skip to content

Commit 85e8710

Browse files
committed
chore(humanify): update project readme
1 parent a466db1 commit 85e8710

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ Once this pattern is applied in any app component we highly recommend to switch
7272
- **Method Naming**: We use an `object_action[_context]` naming convention for methods (e.g., `place_retrieve_by_user()`, `user_update()`). This helps in keeping the codebase organized and easy to navigate.
7373

7474
## Current Apps
75-
- **users**: The `users` app handles user-related functionalities.
76-
- **api**: The `api` app centralize API routing. This app typically contains api versions that includes URL patterns from other apps, providing a single entry point for all API requests and making versioning or global API changes more manageable.
77-
- **common**: The `common` app is used to house highly generic and reusable code as public services that are not specific nor related to any single application but are used across the project. This promotes DRY principles and keeps app-specific logic clean.
7875
- **image_processing**: The `image_processing` app handle general image-related functionalities, such as processing transformations and object detection.
79-
- The `image_processing` app its meant to be extracted to a new app in the future as it will grow and become more complex, inner apps should use the `image_processing/api` interfaces that supports built-in types instead of accessing the app `src` functionalities.
76+
- The `image_processing` app its meant to be extracted to a new app in the future as it will grow and become more complex, inner apps should use the `image_processing_api` services that supports built-in types instead of accessing the app `image_processing` functionalities.
8077
- **places**: The `places` app allows to create and handle `Places`.
8178
- A `Place` is a basic virtual representations of a real place with a real-world counterpart.
79+
- **users**: The `users` app handles user-related functionalities.
80+
- **api**: The `api` app centralize API routing. This app typically contains api versions that includes URL patterns from other apps, providing a single entry point for all API requests and making versioning or global API changes more manageable.
81+
- **common**: The `common` app is used to house highly generic and reusable code as public services that are not specific nor related to any single application but are used across the project. This promotes DRY principles and keeps app-specific logic clean.
8282

8383

8484
## Taskfile and Docker

0 commit comments

Comments
 (0)