chore/adjust-readme #1

Merged
mnky merged 4 commits from chore/adjust-readme into main 2026-03-06 16:01:23 +00:00
Showing only changes of commit dc43bf3f01 - Show all commits

View File

@@ -1,59 +1,62 @@
# NgrxPlayground
# NgRx Playground
This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 21.2.1.
> An Angular application for exploring and learning NgRx state management patterns.
## Development server
Built with **Angular CLI v21.2.1** · Tested with **Vitest**
To start a local development server, run:
---
## Getting Started
### Prerequisites
- Node.js (LTS recommended)
- Angular CLI: `npm install -g @angular/cli`
### Installation
```bash
npm install
```
### Development Server
```bash
ng serve
```
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
Open [http://localhost:4200](http://localhost:4200) in your browser. The app reloads automatically on file changes.
## Code scaffolding
---
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
## Scripts
```bash
ng generate component component-name
| Command | Description |
|---|---|
| `ng serve` | Start development server |
| `ng build` | Build for production |
| `ng test` | Run unit tests with Vitest |
| `ng e2e` | Run end-to-end tests |
| `ng generate component <name>` | Scaffold a new component |
---
## Project Structure
```
src/
├── app/
│ ├── store/ # NgRx state, actions, reducers, effects, selectors
│ └── ...
├── assets/
└── environments/
```
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
---
```bash
ng generate --help
```
## Resources
## Building
To build the project run:
```bash
ng build
```
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
## Running unit tests
To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
```bash
ng test
```
## Running end-to-end tests
For end-to-end (e2e) testing, run:
```bash
ng e2e
```
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
## Additional Resources
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
- [NgRx Documentation](https://ngrx.io/docs)
- [Angular Documentation](https://angular.dev)
- [Angular CLI Reference](https://angular.dev/tools/cli)
- [Vitest](https://vitest.dev)