Sometime back I wrote a post on using Angular and Require to create a project template. The idea was to make the application more modular and broken down into multiple components that can be easily reused. I have made some more modifications to the template, especially the naming conventions used for files and minor changes to the structure of the project.
Here's the snapshot of the directory structure:
The major change has been moving the stylesheets (scss files) for the various components inside the components directory and create <component>.module.js file inside the same directory. I have removed the modules directory which listed all the module files for the application. This change enables reusing the component by copying one single directory instead of copying multiple directories (scripts and styles).
The next change was to create a module for the models listed under domain directory. These models were associated with components but that didn't encourage reusability. By having one domain module that lists all domain services, it can be used across the application. Also, the idea is to have components being agnostic of the services. The components are responsible for rendering the views and they delegate the responsibility of calling a service to the parent controllers which are listed under pages directory (see previous post).
The services directory would contain a set of common services that can be used by components or services. I have added backendUrlsProvider.js file which is a constant service, providing a map between the service and the corresponding URLs:
If there's a change in the URL then it would be updated here and no changes would be required to be made in the services files.
A new addition to the template is the use of the Gulp to generate the build. The build generation steps include: cleaning the dist directory, running jshint, compiling and minifying stylesheets, annotating Angular files using @ngInject, minifying HTML files, minifying JavaScript files using r.js optimizer, adding a new revision, using html-replace to inject JavaScript files and CSS stylesheets, removing mock modules reference when a Production build is generated.
Take a look at the code on Github: https://github.com/sagar-ganatra/angular-require-template
Here's the snapshot of the directory structure:
/components /login login.directive.js login.html login.module.js login.scss /domain domain.module.js Players.js User.js /services backendUrlsProvider.js common-services.module.js
The major change has been moving the stylesheets (scss files) for the various components inside the components directory and create <component>.module.js file inside the same directory. I have removed the modules directory which listed all the module files for the application. This change enables reusing the component by copying one single directory instead of copying multiple directories (scripts and styles).
The next change was to create a module for the models listed under domain directory. These models were associated with components but that didn't encourage reusability. By having one domain module that lists all domain services, it can be used across the application. Also, the idea is to have components being agnostic of the services. The components are responsible for rendering the views and they delegate the responsibility of calling a service to the parent controllers which are listed under pages directory (see previous post).
The services directory would contain a set of common services that can be used by components or services. I have added backendUrlsProvider.js file which is a constant service, providing a map between the service and the corresponding URLs:
return { login: '/user/login', register: '/user/register', players: '/players' };
If there's a change in the URL then it would be updated here and no changes would be required to be made in the services files.
A new addition to the template is the use of the Gulp to generate the build. The build generation steps include: cleaning the dist directory, running jshint, compiling and minifying stylesheets, annotating Angular files using @ngInject, minifying HTML files, minifying JavaScript files using r.js optimizer, adding a new revision, using html-replace to inject JavaScript files and CSS stylesheets, removing mock modules reference when a Production build is generated.
Take a look at the code on Github: https://github.com/sagar-ganatra/angular-require-template
Comments
Post a Comment