Git Product home page Git Product logo

angular-boilerplate-material's Introduction

Angular Boilerplate

This project was generated with Angular CLI version 9.1.6. This is purely a boilerplate with authentication pages. I think mainly is an example layout more than anything else as there isn't a defined backend.

The folder structure of this project was inspired by this video.

Features

  • Dynamic loading spinner
  • Authentication Guard
  • Some base components (card, confirm dialog, user-avatar)
  • local/session storage
  • Push and toaster Notification support
  • Dynamic model implementation (use user.model.ts as an example)
  • Base application layout
  • Service Worker implementation
  • Base scss flexbox classes, various scss mixins and theme implementation
  • Testing infrastructure
  • Global Error Handling
  • compodoc implementation
  • Uses Angular Material for theming
  • Storybook already setup and working

Things to change

Upon first configuration you will want to change the following items:

  • package.json - The name field. This is used to drive the site title, header title and localStorage/sessionStorage prefix. I've made this a template on GitHub so this step may not be required.
  • src/environments/environment*.ts - Update the Notifications Server public key variable. This is to support push notifications. Leave it blank if push notifications are not going to be used
  • src/app/core/interfaces/api.interface.ts - Update the ApiEndpoints enum to match your routes

Custom npm scripts

Development server

Run ng serve for a dev server. Navigate to http://localhost:4201/. The app 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. Use the --prod flag for a production build.

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 Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

angular-boilerplate-material's People

Stargazers

Sajeev avatar Nguyen Chinh Hiep avatar

Watchers

Keith Strickland avatar James Cloos avatar

Forkers

johndshea

angular-boilerplate-material's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.