Angular Boilerplate

Angular Boilerplate for new projects.

Dependencies

• Angular : 17.1.0
• Angular CLI : 17.1.0
• Angular SSR : 17.1.0
• Bootstrap : 5.3.0
• Fontawesome : 6.4.0

System requirements

• Node v18+
• Angular v17.1.0+

Features

• Angular 17
• Angular Material
• Unit Testing with Jest
• End-to-End Testing with TestCafé
• Internationalization with Transloco
• Auto documentation with Compodoc
• Provide component examples with Storybook
• Analyse your project with source-map-explorer
• Docker
• ESLint
• Prettier
• Commit Linting
• AuditJS Audit this application using Sonatype OSS Index
• Auto-generate a CHANGELOG with auto-changelog
• Lazy Loading
• Server Side Rendering
• Progressive Web App
• Responsive Layout
• Search Engine Optimization (SEO)
• Atomic Design
• Template Driven Forms

Install / Development

# Clone the project
$ git clone https://github.com/Patryk-S-W/angular-boilerplate
$ cd angular-boilerplate

# Install dependencies
$ npm install

# Start server
$ npm run start

# Open in browser: http://localhost:4200

Docker Deployment

# Build Docker image
$ docker build . -t angular-boilerplate

# Run Docker Container
$ docker run -p 3000:80 angular-boilerplate

Commands

• npm run start - Start the app
• npm run lint - Lint the project
• npm run test - Run unit tests
• npm run build - Build the project
• npm run build:prod - Build the project in production mode
• npm run build:prod:stats - Build the project in product mode with stats
• npm run build:ssr - Build the project with Server-Side Rendering
• npm run analyze - Analyse bundle with webpack-bundle-analyzer
• npm run compodoc - Generate compodoc documentation
• npm run version - Generate changelog
• npm run prettier - Format the whole project
• npm run audit - Audit this application using Sonatype OSS Index

License

MIT License

Copyright (c) 2024 Patryk Sadowski

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.