Skip to content

ArslanAmeer/angular-boilerplate

Repository files navigation

Angular Boiler Plate

angular document

A Scalable Angular Boiler Plate, contains all the necessary files and folders to start a new project without needing to create them from scratch. It also contains a lot of features that are required in most of the projects including authentication, lazy loading, guards, etc.

This boilerplate includes the following features:

  • Scalable folder structure.
  • Separation of concerns (Adapting Domain Driven Design).
  • Modularization of components, services, pipes, directives, etc.
  • Lazy loading of modules.
  • Routing with guards.
  • Complete authentication system (Auth service, guard, interceptors etc ).
  • Authentication with JWT.
  • Guards for authentication and authorization.
  • Interceptors.
  • Error handling.
  • Class based entities. (Adapting Domain Driven Design).
  • Implementation of Class Transformers so that we can transform our entities to and from backend data models. Usually apis return data in snake case and we need to convert them to camel case and vice versa.
  • Environments for development and production.
  • Utility functions for common tasks.
    • Local storage obfuscation with getters and setters which automatically encrypt and decrypt data on production and can add more functions as per requirements.
  • Helper functions for common tasks.

And many more...

Please note that this boilerplate is not a complete solution for all the projects. It is just a starting point for your project. You can use this boilerplate as a starting point for your project and then add or remove features as per your requirements. The features and folder structure of this boilerplate are based on my experience of working on several projects.

This boilerplate will remain updated with the latest versions of Angular and other dependencies. It will also be updated with new features as they are required in most of the projects.

This is a template for README.md file for your project. You can use this template to create your own README.md file for your project.

Note: You can remove this with all the above lines and use rest in your documentation.

Web Front-End

Status Badges

 

💻 Current Stack Version:

  • Node ^v18
  • Angular ^v16

 

🚀 Project setup

If you want to setup this project locally and start developing, read Setup

 

😎 Coding style

We make use of Javascript Standard Style while developing.

You can integrate it with eslint linter tool in your IDE to help smoothen the process by integrating automatic linting in compile time

If you want to read more about the rules, read Coding style

 

🧳 Dependencies

If you want to read more about dependencies in this platform, read Dependencies

 

🪢 Helper and Utility functions

We have several helper and utility functions that play a big part of the platform. They are available in core\helpers and core\utils folder.

 


📜 Change Logs:

(Latest)

 

[Version 0.0.0] - 2023-01-20

Added

Changed

Fixed


 

You can see all change logs Here.

 


Author:

Arslan Ameer | GitHub