፨ This project is in active development, feel free to contribute! - preview the live app here -

Features

• Angular2+ SPA front-end project boilerplate
• UIkit3 Sass-ready as web interface framework
• Production and Development lite server with Livereload
• ngx-config for global configuration management.
• ngx-meta for SEO title and meta tags (including Open Graph tags for social sharing).
• ngx-translate for i18n support.
• ngx-auth for simple JWT-based authentication.
• ngx-i18n-router for localized routes.
• Unit tests with Jasmine and Karma, including code coverage via Istanbul.
• End-to-end tests with Protractor.
• angular-tslint-rules as configuration preset for TSLint and codelyzer.

Prerequisites

Before moving on, make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. OSX and Linux machines typically have this already installed, neither simply brew it!

• Node.js - Download & Install Node.js. Then verify that you are running node v4.x.x or higher and npm 3.x.x or higher by running the commands node -v and npm -v in a terminal/console window.

• Angular-cli - You're going to use the Angular cli to build the front-end. Make sure you've installed Node.js first and then install angular cli globally using npm install -g @angular/cli.

Usage

# Clone the project
git clone --depth=1 git@github.com:whoisjorge/angular-uikit.git && rm -rf angular-uikit/.git

# Install dependencies
npm i #or yarn

# run the development server
npm start

Development server

Also you can 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.

Tests

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.

License

This is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE for details.

_{^{</>
@whoisjorge}}