This project was generated with Angular CLI version 13.0.0.
- Getting Started
- What's in the box ?
- Code scaffolding
- Build
- Running unit tests
- Running end-to-end tests
- Further help
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them :
- Git
- Angular CLI installed globally recommended
-
Clone the git repository
git clone https://github.com/smarlhens/ngx-boilerplate.git
-
Go into the project directory
cd ngx-boilerplate/ -
Checkout working branch
git checkout <branch>
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 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 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 optionalAre you a good commitizen ?
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 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 is a package that helps you create Git hooks easily.
Configuration file: .huskyrc.
Lint-staged is a Node.js script that allows you to run arbitrary scripts against currently staged files.
Configuration file: .lintstagedrc.
Prettier is an opinionated code formatter.
Configuration file: .prettierrc.
Ignore file: .prettierignore.
For more configuration options and details, see the configuration docs.
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.
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.
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.
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.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.