{"id":16429948,"url":"https://github.com/smarlhens/ngx-boilerplate","last_synced_at":"2025-10-26T23:31:36.902Z","repository":{"id":37109297,"uuid":"326962659","full_name":"smarlhens/ngx-boilerplate","owner":"smarlhens","description":"Angular boilerplate with CircleCI, Commitizen, Commitlint, ESLint, GitHub Actions, Husky, Lint-staged, Prettier, Travis CI","archived":true,"fork":false,"pushed_at":"2023-01-25T07:17:05.000Z","size":1359,"stargazers_count":2,"open_issues_count":20,"forks_count":0,"subscribers_count":2,"default_branch":"ng-13","last_synced_at":"2024-10-28T17:10:45.799Z","etag":null,"topics":["angular","boilerplate","circleci","commitizen","commitlint","conventional-commits","eslint","github-actions","husky","lint-staged","playwright","prettier","travis-ci","tslint"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smarlhens.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-05T10:23:28.000Z","updated_at":"2024-07-21T19:16:41.000Z","dependencies_parsed_at":"2023-02-14T05:30:20.474Z","dependency_job_id":null,"html_url":"https://github.com/smarlhens/ngx-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":"smarlhens/ng10-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fngx-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fngx-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fngx-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smarlhens%2Fngx-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smarlhens","download_url":"https://codeload.github.com/smarlhens/ngx-boilerplate/tar.gz/refs/heads/ng-13","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238412980,"owners_count":19467933,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","boilerplate","circleci","commitizen","commitlint","conventional-commits","eslint","github-actions","husky","lint-staged","playwright","prettier","travis-ci","tslint"],"created_at":"2024-10-11T08:25:01.784Z","updated_at":"2025-10-26T23:31:31.591Z","avatar_url":"https://github.com/smarlhens.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Angular 13 - Boilerplate\n\n[![GitHub CI](https://github.com/smarlhens/ngx-boilerplate/workflows/ci/badge.svg?branch=ng-13)](https://github.com/smarlhens/ngx-boilerplate/actions/workflows/ci.yml)\n[![CircleCI](https://circleci.com/gh/smarlhens/ngx-boilerplate/ng-13?style=svg)](https://circleci.com/gh/smarlhens/ngx-boilerplate)\n[![Build Status](https://travis-ci.com/smarlhens/ngx-boilerplate.svg?branch=ng-13)](https://travis-ci.com/smarlhens/ngx-boilerplate)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)\n[![GitHub issues](https://img.shields.io/github/issues/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/issues)\n[![GitHub pull requests](https://img.shields.io/github/issues-pr/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/pulls)\n[![GitHub stars](https://img.shields.io/github/stars/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/network)\n[![GitHub contributors](https://img.shields.io/github/contributors/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/graphs/contributors)\n[![GitHub license](https://img.shields.io/github/license/smarlhens/ngx-boilerplate)](https://github.com/smarlhens/ngx-boilerplate/tree/ng-13)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/smarlhens/ngx-boilerplate)\n![GitHub repo size](https://img.shields.io/github/repo-size/smarlhens/ngx-boilerplate)\n\nThis project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.0.0.\n\n## Table of contents\n\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n- [What's in the box ?](#whats-in-the-box-)\n  - [CircleCI](#circleci)\n  - [Commitizen](#commitizen)\n  - [Commitlint](#commitlint)\n  - [ESLint](#eslint)\n  - [GitHub Actions](#github-actions)\n  - [Husky](#husky)\n  - [Lint-staged](#lint-staged)\n  - [Prettier](#prettier)\n  - [Travis CI](#travis-ci)\n- [Code scaffolding](#code-scaffolding)\n- [Build](#build)\n- [Running unit tests](#running-unit-tests)\n- [Running end-to-end tests](#running-end-to-end-tests)\n- [Further help](#further-help)\n\n---\n\n## Getting started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n### Prerequisites\n\nWhat things you need to install the software and how to install them :\n\n- [Git](https://git-scm.com/)\n- [Angular CLI](https://cli.angular.io/) _installed globally recommended_\n\n### Installation\n\n1. Clone the git repository\n\n   ```bash\n   git clone https://github.com/smarlhens/ngx-boilerplate.git\n   ```\n\n1. Go into the project directory\n\n   ```bash\n   cd ngx-boilerplate/\n   ```\n\n1. Checkout working branch\n\n   ```bash\n   git checkout \u003cbranch\u003e\n   ```\n\n---\n\n## What's in the box ?\n\n### CircleCI\n\n[CircleCI](https://circleci.com/) automates your software builds, tests, and deployments.\n\n**CircleCI pipeline file**: [`.circleci/config.yml`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.circleci/config.yml).\n\nFor more configuration options and details, see the [configuration docs](https://circleci.com/docs/).\n\n---\n\n### Commitizen\n\n[commitizen](https://github.com/commitizen/cz-cli) is a command line utility that makes it easier to create commit messages following the [conventional commit format](https://conventionalcommits.org) specification.\n\nUse `git cz` instead of `git commit` to use commitizen.\n\n[![Add and commit with Commitizen](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)](https://github.com/commitizen/cz-cli/raw/master/meta/screenshots/add-commit.png)\n\n**Configuration file**: [`.czrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.czrc).\n\n---\n\n### Commitlint\n\n[commitlint](https://github.com/conventional-changelog/commitlint) checks if your commit messages meet the [conventional commit format](https://conventionalcommits.org).\n\n**Configuration file**: [`.commitlintrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.commitlintrc).\n\nIn general the pattern mostly looks like this:\n\n```sh\ntype(scope?): subject  #scope is optional\n```\n\nAre you a good `commitizen` ?\n\n---\n\n### ESLint\n\n[ESLint](https://eslint.org/) is a fully pluggable tool for identifying and reporting on patterns in JavaScript.\n\n**Ignore file**: [`.eslintignore`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.eslintignore).\n**Configuration file**: [`.eslintrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.eslintrc).\n\nFor more configuration options and details, see the [configuration docs](https://eslint.org/docs/user-guide/configuring).\n\n---\n\n### GitHub Actions\n\n[GitHub Actions](https://github.com/features/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.\n\n**CI workflow file**: [`.github/workflows/ci.yml`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.github/workflows/ci.yml).\n\n---\n\n### Husky\n\n[Husky](https://github.com/typicode/husky) is a package that helps you create Git hooks easily.\n\n**Configuration file**: [`.huskyrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.huskyrc).\n\n---\n\n### Lint-staged\n\n[Lint-staged](https://github.com/okonet/lint-staged) is a Node.js script that allows you to run arbitrary scripts against currently staged files.\n\n**Configuration file**: [`.lintstagedrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.lintstagedrc).\n\n---\n\n### Prettier\n\n[Prettier](https://prettier.io/) is an opinionated code formatter.\n\n**Configuration file**: [`.prettierrc`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.prettierrc).  \n**Ignore file**: [`.prettierignore`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.prettierignore).\n\nFor more configuration options and details, see the [configuration docs](https://prettier.io/docs/en/configuration.html).\n\n---\n\n### Travis CI\n\n[Travis CI](https://travis-ci.com/) is a hosted continuous integration service used to build and test software projects hosted at GitHub.\n\n**Travis build file**: [`.travis.yml`](https://github.com/smarlhens/ngx-boilerplate/blob/ng-13/.travis.yml).\n\nFor more configuration options and details, see the [configuration docs](https://docs.travis-ci.com/).\n\n---\n\n## Development server\n\nRun `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.\n\n---\n\n## Code scaffolding\n\nRun `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.\n\n---\n\n## Build\n\nRun `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.\n\n---\n\n## Running unit tests\n\nRun `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).\n\n---\n\n## Running end-to-end tests\n\nRun `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).\n\n---\n\n## Further help\n\nTo get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarlhens%2Fngx-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmarlhens%2Fngx-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmarlhens%2Fngx-boilerplate/lists"}