Angular Boilerplate
English | Espaรฑol
This opinionated Angular starter focuses on the latest Angular features and best practices. It offers essential features for flexibility and scalability, minimizing unnecessary overhead. The codebase is lightweight yet robust, allowing developers to choose their preferred technologies like UI component libraries, state management, server-side rendering, etc. Its flexible boilerplate enables easy customization and adaptation to unique project requirements.
โ๏ธ Features
- Angular 16
- PNPM, esbuild
- Standalone components
- Signals
- Lazy loading
- PWA
- I18n
- TailwindCSS
- OS/Light/Dark themes
- Lightweight, fast, and built using state-of-the-art technology.
โ Ready-to-use
UI Frameworks
Icons
- Iconify - use icons from any icon sets ๐Icรดnes.
- @iconify/tailwind - Pure CSS icons.
Add-ons
- https://github.com/ngneat/transloco
- https://github.com/tailwindlabs/tailwindcss
- https://github.com/iconify/iconify
โ Prerequisites
- Node.js (^16.14.0 || ^18.10.0): https://nodejs.org/en/
- PNPM: https://pnpm.io/es/
- Docker (optional): https://www.docker.com/
๐น Start development
Note: You have three options to start a new project based on this template:
- Create a new GitHub repository from this template.
- Clone this repository to start with a clean git history.
- Scaffold a project fork on StackBlitz.
Using the GitHub template
Create a repo from this template on GitHub.
Cloning the repository locally
npx degit juanmesa2097/angular-boilerplate my-app && cd my-app && ./scripts/rename_project.sh my-app
Install dependencies
pnpm install # run `pnpm install -g pnpm` if you don't have pnpm installed
Run project
pnpm dev
๐ Checklist
Please review this checklist and modify it as necessary to meet your project requirements.
- Run the
./scripts/rename_project.sh
script to rename the project. - Change the title in
src/index.html
and the favicon insrc/favicon.ico
to match your project. - Decide whether to continue using simple-git-hooks and lint-staged for your project.
- Clean up the README file to provide clear instructions about your project.
- Modify the pages in the project to meet your specific requirements.
๐ฆ Deploy to Vercel
๐ฆ Deploy to Netlify
๐ณ Docker
Create an image of the project.
docker buildx build -t angular-boilerplate:latest .
Run the image of the project.
docker run --rm -p 8080:80 -d angular-boilerplate:latest
๐งโโ๏ธ Commands
Command | Description | npm | yarn | pnpm |
---|---|---|---|---|
dev |
Starts the development server | npm run dev |
yarn dev |
pnpm dev |
dev:host |
Starts the development server with a custom host | npm run dev |
yarn dev |
pnpm dev |
build |
Builds the production code | npm run build |
yarn build |
pnpm build |
watch |
Builds the production code and watches for changes | npm run watch |
yarn watch |
pnpm watch |
test |
Runs the unit tests | npm run test |
yarn test |
pnpm test |
test:headless |
Runs the unit tests in headless mode | npm run test:headless |
yarn test:headless |
pnpm test:headless |
lint |
Runs the linter | npm run lint |
yarn lint |
pnpm lint |
lint:fix |
Runs the linter and fixes any linting errors | npm run lint:fix |
yarn lint:fix |
pnpm lint:fix |
lint:staged |
Runs the linter on staged files | npm run lint:staged |
yarn lint:staged |
pnpm lint:staged |
stylelint |
Runs the style linter | npm run stylelint |
yarn stylelint |
pnpm stylelint |
stylelint:fix |
Runs the style linter and fixes any style linting errors | npm run stylelint:fix |
yarn stylelint:fix |
pnpm stylelint:fix |
format |
Formats the code with prettier | npm run format |
yarn format |
pnpm format |