Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jagoda11/angular-template

๐ŸŒŸ Angular Template Project: A starter template for Angular 18 with ESLint, Prettier, TypeScript, and testing setup. ๐Ÿš€
https://github.com/jagoda11/angular-template

angular angular18 eslint-config jasmine karma typescript

Last synced: about 1 month ago
JSON representation

๐ŸŒŸ Angular Template Project: A starter template for Angular 18 with ESLint, Prettier, TypeScript, and testing setup. ๐Ÿš€

Awesome Lists containing this project

README

        

# Angular Template Project ๐ŸŒŸ

![License: Commercial](https://img.shields.io/badge/license-Commercial-pink)
![TypeScript](https://img.shields.io/github/package-json/dependency-version/Jagoda11/angular-template/dev/typescript?label=TypeScript)
![Angular](https://img.shields.io/github/package-json/dependency-version/Jagoda11/angular-template/@angular/core?label=Angular)

A starter template for Angular projects with ESLint, Prettier, and custom scripts. This template is designed to help you kickstart your Angular applications with the latest configurations and best practices. ๐Ÿš€

## Features โœจ

- **Angular**: Latest version of Angular for building modern web applications.
- **ESLint**: Integrated ESLint for code linting and maintaining code quality.
- **Prettier**: Code formatting with Prettier to ensure consistent code style.
- **TypeScript**: Strongly typed JavaScript for better development experience.
- **Karma & Jasmine**: Testing setup with Karma and Jasmine for unit testing.

## Getting Started ๐Ÿ› ๏ธ

### Prerequisites

- Node.js (v23.1.0 or higher)
- npm (v10.9.0 or higher)

### Installation

**Clone the repository**:

```bash
git clone https://github.com/Jagoda11/angular-template.git
cd angular-template
```

**Install dependencies**:

```bash
npm install
```

**Running the Development Server**
To start the development server, run:

```bash
npm start
```

This will start the Angular development server and you can view your application at .

**Building the Project**
To build the project,run:

```bash
npm run build
```

This will create a production build of your application in the dist/ directory.

Running Tests
To run the tests, use:

```bash
npm test
```

This will execute the unit tests using Karma and Jasmine.

**Linting the Code**
To lint the code, run:

```bash
npm run lint
```

This will run ESLint on your project to check for code quality issues.

**Formatting the Code**
To format the code using Prettier, run:

```bash
npm run format
```

This will format your code according to the Prettier configuration.

**Cleaning Up**
To clean up the project (remove node_modules, dist, and package-lock.json), run:

```bash
npm run clean
```

**Custom Scripts**
**Start:** npm start - ๐Ÿš€ Starting development server...

**Build:** npm run build - ๐Ÿ—๏ธ Building project...

**Watch:** npm run watch - ๐Ÿ‘€ Watching for changes...

**Test:** npm test - ๐Ÿงช Running tests...

**Lint:** npm run lint - ๐Ÿ” Linting...

**Clean:** npm run clean - ๐Ÿงฝ Cleaning up...

**Contributing** ๐Ÿค

Contributions are welcome! Please open an issue or submit a pull request.

This project is licensed under the terms of the Commercial License Agreement. For more details, see the [LICENSE](LICENSE.md) file.
ยฉ 2024 Jagoda11