https://github.com/EPAM-JS-Competency-center/angular-scaffold

Scaffold an Angular project with all tooling you need for production projects
https://github.com/EPAM-JS-Competency-center/angular-scaffold

angular scaffold

Last synced: 3 months ago
JSON representation

Scaffold an Angular project with all tooling you need for production projects

• Host: GitHub
• URL: https://github.com/EPAM-JS-Competency-center/angular-scaffold
• Owner: EPAM-JS-Competency-center
• License: mit
• Created: 2022-01-31T13:52:06.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-07-25T20:38:39.000Z (4 months ago)
• Last Synced: 2024-07-25T23:34:49.813Z (4 months ago)
• Topics: angular, scaffold
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/scaffold-angular
• Size: 1.71 MB
• Stars: 8
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

• awesome-angular - angular-scaffold - Scaffold an Angular project with all tooling you need for production projects. (Table of contents / Angular)
• fucking-awesome-angular - angular-scaffold - Scaffold an Angular project with all tooling you need for production projects. (Table of contents / Angular)
• fucking-awesome-angular - angular-scaffold - Scaffold an Angular project with all tooling you need for production projects. (Table of contents / Angular)

README

        
# Scaffold Angular

The package will save you time when starting a new project on Angular. It sets up a working environment with all the

tools every project needs such as ESLint, Stylelint, Git hooks, Prettier.

These ensure smooth development by providing guard rails for code style. Save hours of arguing during pull request

reviews, spending hours teaching the code standards to the new team members. Automated tooling will take care of it for

you.

Strict rules are applied and can be changed later when the app was scaffolded to fulfill the needs of the team.

## Prerequisites

Node >= v18

## Using the package

```bash

npx scaffold-angular my-app

```

## Tooling provided by the package

Currently, the script only supports scaffolding new Angular projects with all tooling listed below enabled and

configured

1. ESLint – runs linting rules over ts/html

   files ([@epam/eslint-config-angular](https://www.npmjs.com/package/@epam/eslint-config-angular))

2. Stylelint – runs linting rules over scss files

3. Prettier - formats all files

4. SVGO - minifies svg images (if run twice in a row could produce two different code results which look identically)

5. Lefthook - git hooks management tool