Skip to content

Commit 8a2526a

Browse files
committed
Update README.md
1 parent bd3ab61 commit 8a2526a

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

Diff for: README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,47 @@ This project is a template for future developments and best pratices on developi
55

66
## Architecture
77

8-
We suggest regular 3 layer approach with some Angular specific organizarion of the Ui layer.
8+
We suggest regular 3 layer approach with some Angular specific organization of the UI layer.
99

1010
![alt tag](https://github.com/zbra-solutions/template_angular_webclient/blob/gh-pages/architecture.png)
1111

1212
#### Model
1313

14-
Missing part in many projects, model does whats expected: defines the entities. It may also contain core validations, factories and everything ralated to properly using and creating valid entities.
14+
Missing part in many projects, model does what's expected: defines the entities. It may also contain core validations, factories and everything ralated to properly using and creating valid entities.
1515

16-
Nothing Angular related (like services or modules) apply to this layer.
16+
Nothing Angular related (like services or modules) applies to this layer.
1717

1818
#### Repository
1919

20-
Although it might seem, by the nature of the word being generally associated with DataBases, something allien to rich web client development, archtecturaly speaking the Repository is the where we store the entities of our application. This layer will interface with the Server instead of a DataBase. It will usually be performing queries and returing instances of entities provided by the model; converting server sent JSON (value objects) into application classes.
20+
Although it might seem, by the nature of the word being generally associated with databases, something alien to rich web client development, architecturally speaking the Repository is where we store the entities of our application. This layer will interface with the server instead of a database. It will usually perform queries and return instances of entities provided by the model, converting server sent JSON (value objects) into application classes.
2121

22-
Implementation of repositories are mostly done by using Angular services.
22+
Implementation of repositories are mostly done through Angular Services.
2323

2424
#### Services
2525

26-
Not to be mistaken by Angular Services (which are indeed used to implement classes not only in this very layer, but also in manu others), this layer is responsible to implement logic that is critical to the application business by leveraging zero or many repositories and adding value and meaning to complex operations that might be or not shared between muitiple parts of the UI.
26+
Not to be mistaken by Angular Services (which are indeed used to implement classes not only in this very layer, but also in many others). This layer is responsible for implementing logic that is critical to the application business by leveraging zero or many repositories and adding value and meaning to complex operations that might be or not shared between multiple parts of the UI.
2727

28-
Like repositories, Services are mostly done by employing Angular services.
28+
Like repositories, Services are mostly done by employing Angular Services.
2929

3030
#### UI
3131

32-
Here goes the most of the app. All html goes here. its divided in three smaller portions to logically organize and provide foundation to sharing code while isolating one feature from another.
32+
Here goes the bulk of the app. All HTML goes here. It's divided in three smaller portions to logically organize and provide foundation for sharing code while isolating one feature from another.
3333

3434
##### Pages
3535

36-
Features go here. Each feature must be isolated from one another and reside in its single Angular module. Default artefacts found in each feature will include the page html file, controller and module file. Optionally, directives might be added according to particular neccessities, like isolating a specific modal.
36+
Features go here. Each feature must be isolated from one another and reside in its single Angular Module. Default artifacts found in each feature will include the page HTML, Controller and Module files. Optionally, directives might be added according to particular neccessities, like isolating a specific modal.
3737

3838
##### Components
3939

40-
Components are a single Angular module containing UI components to be shared accross Pages. Components in this module should avoid accessing services or repository or encapsulate, intead being more focused on visual representation and reusability. Usually implemented through Angular directives.
40+
Components are a single Angular module containing UI components to be shared accross Pages. Members of this module should avoid accessing Services or Repositories, instead being more focused on visual representation and reusability. Usually implemented through Angular Directives.
4141

4242
##### Mediators
4343

44-
Mediators, like Components, live in a single Angular module. Classes here are responsible for isolating commun behavior executed throughout the application UI. Isolae vendor specific services like mdNotification and provide a single point of standardized and simplified interaction with the library is great use of this layer.
44+
Mediators, like Components, live in a single Angular Module. Classes here are responsible for isolating common behavior executed throughout the application UI. Isolate vendor specific services like mdNotification and provide a single point of standardized and simplified interaction with the library is a great use of this layer.
4545

4646
## Auxiliary Tools & Configurations
4747

48-
Project is tailored to be used with WebStorm 11, but its not obligatory. Although some niceties that are already configured will be lost, its completely possible to replicate such configurations in other IDE. Having that said, use of WebStorm is highly favored.
48+
Project is tailored to be used with WebStorm 11+, but its not obligatory. Although some niceties that are already configured will be lost, it's completely possible to replicate such configurations on other IDEs. Having that said, use of WebStorm is highly favored.
4949

5050
The stack of tools used include:
5151

@@ -56,13 +56,11 @@ The stack of tools used include:
5656
* LESS: Less compiler
5757
* WebStorm: IDE, automation of some tasks
5858

59-
Only required pre-installed software is NPM and WebStorm. Check out the project, open it in WebStorm then run ___npm install___ on the console and it will:
59+
Only required pre-installed software is NPM and WebStorm. Check out the project, open it in WebStorm then run __npm install__ on the console and it will:
6060

6161
* Download Bower, Gulp, Typings and LESS compiler
6262
* Download Bower dependencies into __assets/bower_components__ directory
6363
* Download typings into __typings__ directory
6464
* Compile the empty less file into __assets/css/app.css__
6565

66-
Additionally every update of any of the Bower (__bower.json__), Typings (__typings.json__) or any __.less__ file in __/less__ should trigger an automatic update commands such as after you SVN update, updated libraries, css and typings will not go unoticed.
67-
68-
66+
Additionally, every update of any Bower (__bower.json__), Typings (__typings.json__) or any __.less__ file in __/less__ should trigger an automatic update command.

0 commit comments

Comments
 (0)