⚠️ Moved to smarlhens/ngx-boilerplate/ng-10

Angular 10 - Boilerplate

This project was generated with Angular CLI version 10.0.0.

Table of contents

• Getting Started
  • Prerequisites
  • Installation
• What's in the box ?
  • CircleCI
  • Commitizen
  • Commitlint
  • ESLint
  • GitHub Actions
  • Husky
  • Lint-staged
  • Prettier
  • Travis CI
• Code scaffolding
• Build
• Running unit tests
• Running end-to-end tests
• Further help

---

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them :

• Git
• Angular CLI installed globally recommended

Installation

1. Clone the git repository

   git clone https://github.com/smarlhens/ng10-boilerplate.git

2. Go into the project directory

   cd ng10-boilerplate/

3. Checkout working branch

   git checkout <branch>

---

What's in the box ?

CircleCI

CircleCI automates your software builds, tests, and deployments.

CircleCI pipeline file: .circleci/config.yml.

For more configuration options and details, see the configuration docs.

---

Commitizen

commitizen is a command line utility that makes it easier to create commit messages following the conventional commit format specification.

Use git cz instead of git commit to use commitizen.

Configuration file: .czrc.

---

Commitlint

commitlint checks if your commit messages meet the conventional commit format.

Configuration file: .commitlintrc.

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional

Are you a good commitizen ?

---

ESLint

ESLint is a fully pluggable tool for identifying and reporting on patterns in JavaScript.

Ignore file: .eslintignore. Configuration file: .eslintrc.

For more configuration options and details, see the configuration docs.

---

GitHub Actions

GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want.

CI workflow file: .github/workflows/ci.yml.

---

Husky

Husky is a package that helps you create Git hooks easily.

Configuration file: .huskyrc.

---

Lint-staged

Lint-staged is a Node.js script that allows you to run arbitrary scripts against currently staged files.

Configuration file: .lintstagedrc.

---

Prettier

Prettier is an opinionated code formatter.

Configuration file: .prettierrc.
Ignore file: .prettierignore.

For more configuration options and details, see the configuration docs.

---

Travis CI

Travis CI is a hosted continuous integration service used to build and test software projects hosted at GitHub.

Travis build file: .travis.yml.

For more configuration options and details, see the configuration docs.

---

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.

---

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.

---