From 09108efb88e41c15cb63149fcae11cfe6e554726 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 27 Jun 2023 14:59:55 +0300 Subject: [PATCH] Edit README (#55) --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b735fc39..dbcb2675 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ * clone the project to your local machine ### build -* cd to the root of the project +* `cd` to the root of the project * run `npm ci` to install required node modules * run `npm run build` @@ -24,7 +24,7 @@ Contains only logic. no declarations. no dependency with any other module beside Application feature modules. each module can contain declarations and providers **specific to the the feature** Depend only on shared module for ui components -#####each feature should contain the following: +##### Each feature should contain the following: - **module** - the feature module: `.module.ts`. - **component** - the feature main component js file, should contain the feature's containers components only: `.component.ts`. - **component** html - the feature component html: `.component.html`. @@ -34,8 +34,7 @@ Depend only on shared module for ui components - **model** - the feature types, interfaces and objects declarations: `.model.ts`. - **actions** - redux action classes - file name: `.actions.ts` - **effects** - ngrx effects classes. manage data flow and side effects - file name: `.effect.ts` -- **reducers** - simple functions for state composition. file name: ` -.reducer.ts` +- **reducers** - simple functions for state composition. file name: `.reducer.ts` - **services** - utilities classes with the same responsibility under `services` folder : `.service.ts`. - **container components** - components that will include dumb components and will pass data from the state to the dumb components and dispatch actions of the dumb components, the container components will be under `containers` folder. - **dumb components** - stateless view components that will communicate through inputs and outputs, the dumb components will be under `dumb` folder.