cichy380 / angular-starter-app

Angular Starter Template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

project under maintenance

Angular Starter App

Angular Starter App

TravisCi Build Status CodeFactor pipeline status MIT badge

Angular Starter App is real word boilerplate to speedup your development. Just focus on your main features and dont waist your time on setting up the whole necessary angular environment.

If you are interested of contributing, go to CONTRIBUTING to make this project more awesome! 😎

Why Angular Starter App?

Using this starter you will save a lot of hours and this will make sure that you are creating your app following the best practise.

Features

  • Highly scalable folder structure (core & shared module)
  • Installed and plugged ngrx (store, effects, devtools), Angular Material and Bootstrap
  • Lazy loading feature
  • Notifications
  • Offline indicator
  • Http err handing
  • Mock api (json-server)
  • Loading bar
  • Localstorage
  • Multi env. files
  • Configured tslint rules
  • Docker and docker-compose
  • Proxy
  • etc.

Live Demo

StackBlitz is available - HERE πŸ”₯ !

App demo is available - HERE πŸ”₯ !

Getting Started

Angular Starter App * dont forget to run mock using `npm run mock` in another bash tab.

Check out documentation - HERE πŸ“œ !

App structure

β”œβ”€β”€ mock
β”‚   β”œβ”€β”€ index.js
β”‚   └── routes.json
β”œβ”€β”€ src
β”‚   β”œβ”€β”€ app
β”‚   β”‚   β”œβ”€β”€ app.component.html
β”‚   β”‚   β”œβ”€β”€ app.component.scss
β”‚   β”‚   β”œβ”€β”€ app.component.ts
β”‚   β”‚   β”œβ”€β”€ app.module.ts
β”‚   β”‚   β”œβ”€β”€ app-routing.module.ts
β”‚   β”‚   β”œβ”€β”€ core
β”‚   β”‚   β”‚   β”œβ”€β”€ app-store
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ app-store.effects.ts
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ app-store.reducers.ts
β”‚   β”‚   β”‚   β”‚   └── app-store.state.ts
β”‚   β”‚   β”‚   β”œβ”€β”€ components
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ footer
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ header
β”‚   β”‚   β”‚   β”‚   β”œβ”€β”€ home
β”‚   β”‚   β”‚   β”‚   └── page-not-found
β”‚   β”‚   β”‚   └── core.module.ts
β”‚   β”‚   β”œβ”€β”€ features
β”‚   β”‚   β”‚   └── posts
β”‚   β”‚   β”‚       β”œβ”€β”€ components
β”‚   β”‚   β”‚       β”‚   └── posts
β”‚   β”‚   β”‚       β”‚       β”œβ”€β”€ posts.component.html
β”‚   β”‚   β”‚       β”‚       β”œβ”€β”€ posts.component.scss
β”‚   β”‚   β”‚       β”‚       └── posts.component.ts
β”‚   β”‚   β”‚       β”œβ”€β”€ models
β”‚   β”‚   β”‚       β”‚   └── post.model.ts
β”‚   β”‚   β”‚       β”œβ”€β”€ posts.module.ts
β”‚   β”‚   β”‚       β”œβ”€β”€ posts-routing.module.ts
β”‚   β”‚   β”‚       β”œβ”€β”€ services
β”‚   β”‚   β”‚       β”‚   └── posts-api.service.ts
β”‚   β”‚   β”‚       └── store
β”‚   β”‚   β”‚           β”œβ”€β”€ posts.actions.ts
β”‚   β”‚   β”‚           β”œβ”€β”€ posts.effects.ts
β”‚   β”‚   β”‚           β”œβ”€β”€ posts.reducer.ts
β”‚   β”‚   β”‚           β”œβ”€β”€ posts.selectors.ts
β”‚   β”‚   β”‚           └── posts.state.ts
β”‚   β”‚   └── shared
β”‚   β”‚       β”œβ”€β”€ components
β”‚   β”‚       β”‚   └── notification
β”‚   β”‚       β”œβ”€β”€ interceptors
β”‚   β”‚       β”‚   β”œβ”€β”€ index.ts
β”‚   β”‚       β”‚   └── message.interceptor.ts
β”‚   β”‚       β”œβ”€β”€ material.module.ts
β”‚   β”‚       β”œβ”€β”€ models
β”‚   β”‚       β”‚   β”œβ”€β”€ http-response-model.model.ts
β”‚   β”‚       β”‚   β”œβ”€β”€ local-storage-key.model.ts
β”‚   β”‚       β”‚   └── snackbar.model.ts
β”‚   β”‚       β”œβ”€β”€ services
β”‚   β”‚       β”‚   β”œβ”€β”€ error-handler.service.ts
β”‚   β”‚       β”‚   β”œβ”€β”€ error.service.ts
β”‚   β”‚       β”‚   β”œβ”€β”€ local-storage.service.ts
β”‚   β”‚       β”‚   β”œβ”€β”€ logger.service.ts
β”‚   β”‚       β”‚   └── notification-bar.service.ts
β”‚   β”‚       β”œβ”€β”€ shared.module.ts
β”‚   β”‚       └── store
β”‚   β”‚           β”œβ”€β”€ shared.actions.ts
β”‚   β”‚           β”œβ”€β”€ shared.effects.ts
β”‚   β”‚           β”œβ”€β”€ shared.reducer.ts
β”‚   β”‚           β”œβ”€β”€ shared.selectors.ts
β”‚   β”‚           └── shared.state.ts
β”‚   β”œβ”€β”€ environments
β”‚   β”‚   β”œβ”€β”€ environment.one.ts
β”‚   β”‚   β”œβ”€β”€ environment.prod.ts
β”‚   β”‚   β”œβ”€β”€ environment.ts
β”‚   β”‚   └── environment.two.ts
β”‚   β”œβ”€β”€ styles.scss
β”‚   └── test.ts
β”œβ”€β”€ docker-compose.yml
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ nginx.conf
β”œβ”€β”€ proxy.conf.json
└── tslint.json

Contributing

Want to file a bug, contribute some code, or improve documentation? Excellent!

Read up on guidelines for CONTRIBUTING.

Contributors

This project exists thanks to all these people πŸ’ͺ :

License

Everything in this repository is licensed under the MIT License unless otherwise specified.

Copyright (c) 2020 Mateusz Stanczak

About

Angular Starter Template

License:MIT License


Languages

Language:TypeScript 67.8%Language:HTML 20.4%Language:CSS 7.5%Language:JavaScript 2.5%Language:Shell 1.5%Language:Dockerfile 0.4%