▶️ EasyAngular

Welcome to the EasyAngular boilerplate! This project is designed to help you quickly start a new Angular 18 project with Bootstrap 5 and various useful libraries. It comes with pre-coded elements to streamline your development process.

Getting started

Prerequisites

Make sure you have the following installed :

• Node.js (version 20)
• Angular CLI (version 18) using npm install -g @angular/cli

Installation

Clone the repository :

git clone https://github.com/NicolasRoehm/angular-boilerplate.git
cd angular-boilerplate
npm install

✒️ Usage

• Rename EasyAngular and easy-angular with your project name
• Place favicon generated with RealFavIconGenerator into src/assets/img/favicon folder

Development server

Run the following command for a development server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

ng-serve

Boilerplate content

🗂️ Source code structure

Pages Auth (login, forgot password, validate account) with 2 possible layouts Home 404 Shared components Blocks : toast & progress bar Forms : confirm Layouts : page & header Modals : wrapper Enums : endpoints / environments / storage keys Helpers : storage / string Services : app (for requests) / store (for state management using signals) i18n : en.json (for internationalization)

🌐 Included packages

• Bootstrap 5 : SCSS style & ng-bootstrap components
• Axios : HTTP client
• ArrayTyper : Utility for type-safe array operations
• angular-svg-icon : SVG icon support
• ngx-translate : Internationalization library

🛠️ Tools

• Generate models from JSON - https://app.quicktype.io/
• Generate favicon from SVG - https://realfavicongenerator.net/

Angular CLI commands

Code scaffolding

Generate a new component :

ng generate component component-name

You can also use ng generate for directives, pipes, services, classes, guards, interfaces, enums, and modules.

Build

Build the project :

ng build

The build artifacts will be stored in the dist/ directory.

Running tests

Unit tests

Run unit tests via Karma :

ng test

End-to-End tests

Run end-to-end tests via a platform of your choice. You need to add a package that implements end-to-end testing capabilities :

ng e2e

Further help

To get more help on the Angular CLI, use ng help or visit the Angular CLI Overview and Command Reference page.