https://github.com/gappbox/angular-boilerplate
Angular Boilerplate with ESLint, StyleLint, Jest, Docker
https://github.com/gappbox/angular-boilerplate
Last synced: 2 months ago
JSON representation
Angular Boilerplate with ESLint, StyleLint, Jest, Docker
- Host: GitHub
- URL: https://github.com/gappbox/angular-boilerplate
- Owner: gappbox
- License: mit
- Created: 2023-12-23T12:02:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-16T14:03:13.000Z (7 months ago)
- Last Synced: 2024-11-16T15:17:17.234Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 839 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Angular Boilerplate with ESLint, StyleLint, Jest, Docker
### Download
```bash
curl -OL https://github.com/gskynex/angular-boilerplate/archive/refs/tags/{TAG_VERSION}.zip
```
### Installation
```bash
npm install
```
### Commands
#### Run the project in development mode:
```bash
npm run start
```
The start command launches the Angular development server and opens the project in the browser.
#### Build the project:
```bash
npm run build
```
The build command creates the production version of your project.
#### Build the project with watching for changes:
```bash
npm run build:watch
```
The build:watch command watches for changes in the source code and automatically rebuilds the project.
#### Lint TypeScript and SCSS:
```bash
npm run lint
```
The lint command performs static analysis of TypeScript code and checks SCSS styles.
#### Automatically fix TypeScript issues:
```bash
npm run lint:ts:fix
```
The lint:ts:fix command automatically fixes some errors and styles in TypeScript code.
#### Run Tests:
```bash
npm run test
```
The test command runs tests using Jest.
#### Run Tests with coverage:
```bash
npm run test:coverage
```
The test:coverage command runs tests with code coverage measurement.
#### Set Up Git Hooks:
```bash
npm run prepare
```
The prepare command installs Git Hooks using Husky.
### Dockerize project
#### Build image from the Dockerfile:
```bash
docker build -t angular-boilerplate .
```
#### Run the project as a container using the Docker:
```bash
docker run -d -p80:80 --name=angular-boilerplate angular-boilerplate
```
#### Open Browser:
```bash
http://localhost:80
```