Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wlucha/angular-starter

:rocket: Angular 18 Starter with Storybook, Transloco, Jest, Cypress, Docker, ESLint, Material & Prettier :rocket:
https://github.com/wlucha/angular-starter

angular angular-cli angular-docker angular-material angular18 auditjs boilerplate commit-lint compodoc cypress docker eslint jest material prettier starter starter-kit transloco typescript webpack-bundle-analyzer

Last synced: 7 days ago
JSON representation

:rocket: Angular 18 Starter with Storybook, Transloco, Jest, Cypress, Docker, ESLint, Material & Prettier :rocket:

Host: GitHub
URL: https://github.com/wlucha/angular-starter
Owner: wlucha
License: mit
Created: 2020-05-14T19:09:19.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-11-03T09:14:05.000Z (2 months ago)
Last Synced: 2024-12-29T19:17:38.042Z (14 days ago)
Topics: angular, angular-cli, angular-docker, angular-material, angular18, auditjs, boilerplate, commit-lint, compodoc, cypress, docker, eslint, jest, material, prettier, starter, starter-kit, transloco, typescript, webpack-bundle-analyzer
Language: HTML
Homepage:
Size: 5.78 MB
Stars: 289
Watchers: 6
Forks: 61
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md

Awesome Lists containing this project

README

        ![81993396-d5142b00-9645-11ea-995f-98342b7d5c8f](https://user-images.githubusercontent.com/7531596/128626297-df86020b-1cdc-43b5-a692-6c4c45534ec1.png)

> The Angular starter / boilerplate project to start a new enterprise project.

✅ [Angular 18](https://angular.dev/)  

✅ [Angular Material](https://material.angular.io/)  

✅ Unit Testing with [Jest](https://jestjs.io/)  

✅ End-to-End Testing with [Cypress](https://www.cypress.io/)  

✅ Internationalization with [Transloco](https://github.com/jsverse/transloco)  

✅ Auto documentation with [Compodoc](https://compodoc.app/)  

✅ Provide component examples with [Storybook](https://storybook.js.org/)  

✅ Analyse your project with [source-map-explorer](https://www.npmjs.com/package/source-map-explorer)  

✅ [Docker](https://www.docker.com/)  

✅ [ESLint](https://eslint.org/)  

✅ [Prettier](https://prettier.io/)  

✅ [Commit Linting](https://github.com/conventional-changelog/commitlint)  

✅ [AuditJS](https://www.npmjs.com/package/auditjs) Audit this application using Sonatype OSS Index  

✅ Auto-generate a CHANGELOG with [auto-changelog](https://github.com/cookpete/auto-changelog)



![Angular18](https://img.shields.io/badge/Angular-18-brightgreen)

[![MIT](https://img.shields.io/packagist/l/doctrine/orm.svg)]()

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=wlucha_angular-starter&metric=alert_status)](https://sonarcloud.io/dashboard?id=wlucha_angular-starter)

[![Docker Pulls](https://img.shields.io/docker/pulls/wlucha/angular-starter)](https://hub.docker.com/repository/docker/wlucha/angular-starter)

[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/wlucha/angular-starter)](https://hub.docker.com/repository/docker/wlucha/angular-starter)

[![StackShare](http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/wlucha/angular-starter)

## Deploy

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

## Demo

[![StackBlitz Demo](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/wlucha/angular-starter)

## Install / Development

```bash

# Clone the project

$ git clone https://github.com/wlucha/angular-starter

$ cd angular-starter

# Install dependencies

$ npm install

# Start server

$ npm run start

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

```

## Docker Deployment

```bash

# Build Docker image

$ docker build . -t angular-starter

# Run Docker Container

$ docker run -p 3000:80 angular-starter

```

## Docker Hub

https://hub.docker.com/r/wlucha/angular-starter

## 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 analyse` - Analyse bundle with [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer)

- `npm run compodoc` - Generate [compodoc](https://github.com/compodoc/compodoc) documentation

- `npm run version` - Generate changelog

- `npm run prettier` - Format the whole project

- `npm run audit` - Audit this application using Sonatype OSS Index

- `npm run storybook` - Run Storybook

## License

MIT License

Copyright (c) 2024 Wilfried Lucha

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.