Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[#258] Update the base template structure to follow the Clean Architecture folder structure #262

Merged
merged 15 commits into from
Aug 28, 2023
Merged

[#258] Update the base template structure to follow the Clean Architecture folder structure #262

merged 15 commits into from
Aug 28, 2023

Conversation

doannimble
Copy link
Contributor

What happened 👀

Our current template base structure under lib/ folder is not up to date with the Clean Architecture folder structure. There is no clear separation between the data, domain, and presentation layers. Also, the current structure does not fully follow the Clean Architecture components naming. Therefore, the project outcome lacks a sound foundation to commence development.

Insight 📝

  • Create core, app, domain, data folder
  • Move response, api service, repository_impl to data
  • Move view model, state, screen to app
  • Move network exception to `core_errors``
  • Move models, repository_abstract, usecases to domain
  • Update the mapping model from response
  • Update unit test
  • Refactor package dependencies paths

Proof Of Work 📹

The template is able to be built normally.

@luongvo
Copy link
Member

luongvo commented Aug 4, 2023 •
edited
Loading

@doannimble please rebase to clean up merge commit, and add necessary meta info for this PR 🙏

@doannimble doannimble force-pushed the feature/258-update-clean-architecture branch from 0c90961 to 3eaf713 Compare August 4, 2023 04:34
@doannimble doannimble self-assigned this Aug 4, 2023
@luongvo luongvo added this to the 1.11.0 milestone Aug 4, 2023
@luongvo luongvo linked an issue Aug 4, 2023 that may be closed by this pull request
Update the base template structure to follow the Clean Architecture folder structure #258
Closed
@doannimble
Copy link
Contributor Author

@luongvo Rebased. Please let me know if we need to add more necessary infor 🙏

luongvo
luongvo reviewed Aug 9, 2023
View reviewed changes
bricks/template/__brick__/{{project_name.snakeCase()}}/lib/main.dart Outdated Show resolved Hide resolved
...late/__brick__/{{project_name.snakeCase()}}/lib/domain/usecases/user/get_users_use_case.dart Outdated Show resolved Hide resolved
bricks/template/__brick__/{{project_name.snakeCase()}}/lib/core/errors/network_exceptions.dart Outdated Show resolved Hide resolved
...template/__brick__/{{project_name.snakeCase()}}/lib/data/datasources/remote/api_service.dart Outdated Show resolved Hide resolved
...e/__brick__/{{project_name.snakeCase()}}/test/api/repository/credential_repository_test.dart Outdated Show resolved Hide resolved
...template/__brick__/{{project_name.snakeCase()}}/test/mocks/response/user_response_mocks.dart Outdated Show resolved Hide resolved
...plate/__brick__/{{project_name.snakeCase()}}/test/usecases/user/get_users_use_case_test.dart Outdated Show resolved Hide resolved
bricks/template/__brick__/{{project_name.snakeCase()}}/test/viewmodel/home_view_model_test.dart Outdated Show resolved Hide resolved
@luongvo
Copy link
Member

luongvo commented Aug 22, 2023

@doannimble why do we have some commits tagged with #169 task in this PR? 🤔 If they belong to this #258, could you please "reword" them?

luongvo
luongvo reviewed Aug 22, 2023
View reviewed changes
Copy link
Member

@luongvo luongvo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest lgtm. You're getting familiar with Mason quite fast 💪

bricks/template/__brick__/{{project_name.snakeCase()}}/integration_test/my_home_page_test.dart Outdated Show resolved Hide resolved
sample/lib/api/api_service.dart Outdated Show resolved Hide resolved
bricks/template/__brick__/{{project_name.snakeCase()}}/lib/app/screens/home/home_screen.dart Show resolved Hide resolved
@doannimble doannimble force-pushed the feature/258-update-clean-architecture branch from db39886 to 1a5798a Compare August 25, 2023 03:36
@doannimble doannimble force-pushed the feature/258-update-clean-architecture branch from 1a5798a to fd3e46f Compare August 25, 2023 03:36
@manh-t
Copy link
Contributor

manh-t commented Aug 28, 2023

@doannimble We currently do not have any files in the data/remote/models/requests directory, so it has not been created. Would it be possible to create a .keep file in the directory to ensure it appears in our template? This is a practice from react-template 😄

@luongvo
Copy link
Member

luongvo commented Aug 28, 2023

@doannimble We currently do not have any files in the data/remote/models/requests directory, so it has not been created. Would it be possible to create a .keep file in the directory to ensure it appears in our template? This is a practice from react-template 😄

Possible, nice suggestion imo cc @doannimble

@doannimble
Copy link
Contributor Author

@manh-t Good to know, I've updated.
cc @luongvo

@luongvo luongvo merged commit 6b4cd23 into develop Aug 28, 2023
@luongvo luongvo deleted the feature/258-update-clean-architecture branch August 28, 2023 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@manh-t manh-t manh-t approved these changes

@nkhanh44 nkhanh44 nkhanh44 approved these changes

@luongvo luongvo luongvo approved these changes

@markgravity markgravity Awaiting requested review from markgravity markgravity is a code owner

@sleepylee sleepylee Awaiting requested review from sleepylee sleepylee is a code owner

@chornerman chornerman Awaiting requested review from chornerman chornerman is a code owner

@hoangnguyen92dn hoangnguyen92dn Awaiting requested review from hoangnguyen92dn hoangnguyen92dn is a code owner

@nmint8m nmint8m Awaiting requested review from nmint8m nmint8m is a code owner

@ducbm051291 ducbm051291 Awaiting requested review from ducbm051291 ducbm051291 is a code owner

@thiennguyen0196 thiennguyen0196 Awaiting requested review from thiennguyen0196

@kaungkhantsoe kaungkhantsoe Awaiting requested review from kaungkhantsoe kaungkhantsoe is a code owner

@Shayokh144 Shayokh144 Awaiting requested review from Shayokh144 Shayokh144 is a code owner

@toby-thanathip toby-thanathip Awaiting requested review from toby-thanathip toby-thanathip is a code owner

@Wadeewee Wadeewee Awaiting requested review from Wadeewee

Assignees

@doannimble doannimble

Labels
type : feature
Projects
None yet
Milestone
1.11.0
Development

Successfully merging this pull request may close these issues.

Update the base template structure to follow the Clean Architecture folder structure
5 participants
@doannimble @luongvo @manh-t @nkhanh44 @bot-nimble