Skip to content

nikhilrajnair/angular-dashboard-boilerplate

Repository files navigation

Angular Dashboard Boilerplate

Structure of application

  src/
  ├── app/
  │   ├── core/
  │   │   ├── interceptors/
  │   │   └── services/
  │   ├── layout/
  │   │   ├── header/
  │   │   ├── footer/
  │   │   └── sidebar/
  │   ├── shared/
  │   │   ├── components/
  │   │   └── pipes/
  │   ├── modules/
  │   │   ├── dashboard/
  │   │   │   ├── dashboard.component.ts
  │   │   │   ├── dashboard.component.html
  │   │   │   ├── dashboard.component.scss
  │   │   │   └── dashboard-routing.module.ts
  │   │   └── other-modules/
  │   │       ├── other-module/
  │   │       │   ├── other-module.component.ts
  │   │       │   ├── other-module.component.html
  │   │       │   ├── other-module.component.scss
  │   │       │   └── other-module-routing.module.ts
  │   └── app-routing.module.ts
  │   └── app.component.ts
  │   └── app.component.html
  │   └── app.component.scss
  │   └── app.module.ts
  ├── assets/
  │   ├── images/
  │   └── styles/
  │       ├── variables.scss
  │       ├── mixins.scss
  │       ├── global.scss
  │       ├── light-theme.scss
  │       └── dark-theme.scss
  ├── environments/
  ├── index.html
  ├── main.ts
  ├── polyfills.ts
  ├── styles.scss
  ├── tsconfig.app.json
  ├── tsconfig.json
  └── tsconfig.spec.json

This project was generated with Angular CLI version 15.0.4.

Development

To run linters and formatters, use the following commands:

  • npm run lint: Lints the TypeScript code.
  • npm run lint:fix: Automatically fixes linting issues in the TypeScript code.
  • npm run stylelint: Lints the SCSS styles.
  • npm run stylelint:fix: Automatically fixes stylelint issues in the SCSS styles.
  • npm run format: Formats the TypeScript, SCSS, and HTML code using Prettier.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

  1. Sample Roadmap Refactor folder structure (core, shared, modules) Implement sidebar navigation with active route highlighting (Use routerLinkActive="active" in sidebar links) Dashboard: Add charts, cards, tables (ng2-charts, Material Table) User Module: Fetch/display users from RandomUser API Weather Module: Fetch/display weather for a city Crypto Module (optional): Show live crypto prices Theme toggle: Light/dark mode Testing: Add unit tests for components/services README: Add setup, features, screenshots, and API links

Releases

No releases published

Packages

No packages published