https://github.com/deeleman/ngx-starter
My personal, uber-opinionated, starter project on top of Angular 6, leveraging ready-made SASS recipes and common architectural folder layout
https://github.com/deeleman/ngx-starter
Last synced: about 1 year ago
JSON representation
My personal, uber-opinionated, starter project on top of Angular 6, leveraging ready-made SASS recipes and common architectural folder layout
- Host: GitHub
- URL: https://github.com/deeleman/ngx-starter
- Owner: deeleman
- License: gpl-3.0
- Created: 2018-06-19T09:35:22.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-21T17:30:30.000Z (about 8 years ago)
- Last Synced: 2025-03-27T16:17:16.303Z (over 1 year ago)
- Language: CSS
- Size: 116 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ngx Starter
Ngx starter is my personal, super-opinionated, bootstrap project for simple Angular applications. The goal is to provide a superset of the original base project provided by the Angular CLI, with an already existing SCSS foundation and common folders for shared, core and platform domains.
Please note: this project is not intended for public use. It's just a blueprint for quick projects scaffolding with SASS utility functions.
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.0.8.
## Features
* Super-opinionated linting ruleset
* Shared domain for common-use pipes and directives
* Core domain to allocate global providers within a single unique injector available from root
* Platform domain for provider abstraction and generic type model definition
* Global SCSS library, exposing common SASS mixins, functions and libraries that can be imported within component stylesheets
### Additional utility modules
For the project convenience, some commonly used modules have been added to the bundle. These moduels will be eventually turned inot external Angular libraries by means of the Angular Elements bundler:
* WebSockets client.
* Google Tag Manager wrapper.
* Browser `Window` object wrapper.
* Custom directives: Enter viewport directive, scroll detection directive, back to top directive.
* Custom pipes: Slugify strings pipe.
* SASS utilities: Assorted functions, mixins, environment variables, responsive helpers, etc.
## Development server
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. 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](https://karma-runner.github.io).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).