mirror of
https://github.com/angular/angular-cli.git
synced 2025-06-02 03:12:30 +08:00
198 lines
10 KiB
Markdown
198 lines
10 KiB
Markdown
<!--
|
|
BEFORE UPDATING THIS FILE, READ THIS.
|
|
|
|
This file is automatically generated during release. It is important for you to not update
|
|
README directly.
|
|
|
|
- If you need to change the content, update `scripts/templates/readme.ejs`
|
|
- If you need to add/remove a package or a link, update the .monorepo.json file instead.
|
|
|
|
Any changes to README.md directly will result in a failure on CI.
|
|
-->
|
|
|
|
<h1 style="text-align: center">Angular CLI - The CLI tool for Angular.</h1>
|
|
|
|
<p style="text-align: center">
|
|
<br>
|
|
<img src="/docs/images/angular-cli-logo.png" alt="Angular CLI logo" width="100px" height="108px"/>
|
|
<br><br>
|
|
<em>The Angular CLI is a command-line interface tool that you use to initialize, develop, scaffold,
|
|
<br>and maintain Angular applications directly from a command shell.</em>
|
|
<br>
|
|
</p>
|
|
|
|
<p style="text-align: center">
|
|
<a href="https://angular.dev/tools/cli"><strong>angular.dev/tools/cli</strong></a>
|
|
<br>
|
|
</p>
|
|
|
|
<p style="text-align: center">
|
|
<a href="CONTRIBUTING.md">Contributing Guidelines</a>
|
|
·
|
|
<a href="https://github.com/angular/angular-cli/issues">Submit an Issue</a>
|
|
·
|
|
<a href="https://blog.angular.dev">Blog</a>
|
|
<br>
|
|
<br>
|
|
</p>
|
|
|
|
<hr>
|
|
|
|
## Documentation
|
|
|
|
Get started with Angular CLI, learn the fundamentals and explore advanced topics on our documentation website.
|
|
|
|
- [Getting started][quickstart]
|
|
- [CLI][cli]
|
|
- [Workspace and project file structure][filestructure]
|
|
- [Workspace configuration][workspaceconfig]
|
|
- [Schematics][schematics]
|
|
|
|
## Development Setup
|
|
|
|
|
|
### Prerequisites
|
|
|
|
- Install [Node.js] which includes [Node Package Manager][npm]
|
|
|
|
### Setting Up a Project
|
|
|
|
Install the Angular CLI globally:
|
|
|
|
```
|
|
npm install -g @angular/cli
|
|
```
|
|
|
|
Create workspace:
|
|
|
|
```
|
|
ng new [PROJECT NAME]
|
|
```
|
|
|
|
Run the application:
|
|
|
|
```
|
|
cd [PROJECT NAME]
|
|
ng serve
|
|
```
|
|
|
|
Angular is cross-platform, fast, scalable, has incredible tooling, and is loved by millions.
|
|
|
|
## Quickstart
|
|
|
|
[Get started in 5 minutes][quickstart].
|
|
|
|
## Ecosystem
|
|
|
|
<p>
|
|
<img src="/docs/images/angular-ecosystem-logos.png" alt="angular ecosystem logos" width="500px" height="auto">
|
|
</p>
|
|
|
|
- [Angular Framework][adev]
|
|
- [Angular Material][angularmaterial]
|
|
|
|
## Changelog
|
|
|
|
[Learn about the latest improvements][changelog].
|
|
|
|
## Upgrading
|
|
|
|
Check out our [upgrade guide](https://update.angular.dev/) to find out the best way to upgrade your project.
|
|
|
|
## Contributing
|
|
|
|
### Contributing Guidelines
|
|
|
|
Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more.
|
|
|
|
### Want to Help?
|
|
|
|
Want to report a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing] and then check out one of our issues labeled as <kbd>[help wanted](https://github.com/angular/angular-cli/labels/help%20wanted)</kbd> or <kbd>[good first issue](https://github.com/angular/angular-cli/labels/good%20first%20issue)</kbd>.
|
|
|
|
### Code of Conduct
|
|
|
|
Help us keep Angular open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].
|
|
|
|
### Developer Guide
|
|
|
|
Read through our [developer guide][developer] to learn about how to build and test the Angular CLI locally.
|
|
|
|
|
|
## Community
|
|
|
|
Join the conversation and help the community.
|
|
|
|
- [X (formerly Twitter)][twitter]
|
|
- [Discord][discord]
|
|
- [Gitter][gitter]
|
|
- [YouTube][youtube]
|
|
- [StackOverflow][stackoverflow]
|
|
- Find a Local [Meetup][meetup]
|
|
|
|
## Packages
|
|
|
|
This is a monorepo which contains many tools and packages:
|
|
|
|
|
|
|
|
### Tools
|
|
|
|
| Project | Package | Version | Links |
|
|
|---|---|---|---|
|
|
**Angular Build System** | [`@angular/build`](https://npmjs.com/package/@angular/build) | [](https://npmjs.com/package/@angular/build) | [](/packages/angular/build/README.md) [](https://github.com/angular/angular-build-builds)
|
|
**Angular CLI** | [`@angular/cli`](https://npmjs.com/package/@angular/cli) | [](https://npmjs.com/package/@angular/cli) | [](/packages/angular/cli/README.md) [](https://github.com/angular/cli-builds)
|
|
**Architect CLI** | [`@angular-devkit/architect-cli`](https://npmjs.com/package/@angular-devkit/architect-cli) | [](https://npmjs.com/package/@angular-devkit/architect-cli) | [](https://github.com/angular/angular-devkit-architect-cli-builds)
|
|
**Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://npmjs.com/package/@angular-devkit/schematics-cli) | [](https://github.com/angular/angular-devkit-schematics-cli-builds)
|
|
|
|
|
|
### Packages
|
|
|
|
|
|
| Project | Package | Version | Links |
|
|
|---|---|---|---|
|
|
**Angular SSR** | [`@angular/ssr`](https://npmjs.com/package/@angular/ssr) | [](https://npmjs.com/package/@angular/ssr) | [](/packages/angular/ssr/README.md) [](https://github.com/angular/angular-ssr-builds)
|
|
**Architect** | [`@angular-devkit/architect`](https://npmjs.com/package/@angular-devkit/architect) | [](https://npmjs.com/package/@angular-devkit/architect) | [](/packages/angular_devkit/architect/README.md) [](https://github.com/angular/angular-devkit-architect-builds)
|
|
**Build Angular** | [`@angular-devkit/build-angular`](https://npmjs.com/package/@angular-devkit/build-angular) | [](https://npmjs.com/package/@angular-devkit/build-angular) | [](/packages/angular_devkit/build_angular/README.md) [](https://github.com/angular/angular-devkit-build-angular-builds)
|
|
**Build Webpack** | [`@angular-devkit/build-webpack`](https://npmjs.com/package/@angular-devkit/build-webpack) | [](https://npmjs.com/package/@angular-devkit/build-webpack) | [](/packages/angular_devkit/build_webpack/README.md) [](https://github.com/angular/angular-devkit-build-webpack-builds)
|
|
**Core** | [`@angular-devkit/core`](https://npmjs.com/package/@angular-devkit/core) | [](https://npmjs.com/package/@angular-devkit/core) | [](/packages/angular_devkit/core/README.md) [](https://github.com/angular/angular-devkit-core-builds)
|
|
**Schematics** | [`@angular-devkit/schematics`](https://npmjs.com/package/@angular-devkit/schematics) | [](https://npmjs.com/package/@angular-devkit/schematics) | [](/packages/angular_devkit/schematics/README.md) [](https://github.com/angular/angular-devkit-schematics-builds)
|
|
|
|
#### Misc
|
|
|
|
| Project | Package | Version | Links |
|
|
|---|---|---|---|
|
|
**Angular Create** | [`@angular/create`](https://npmjs.com/package/@angular/create) | [](https://npmjs.com/package/@angular/create) | [](/packages/angular/create/README.md)
|
|
**Webpack Angular Plugin** | [`@ngtools/webpack`](https://npmjs.com/package/@ngtools/webpack) | [](https://npmjs.com/package/@ngtools/webpack) | [](https://github.com/angular/ngtools-webpack-builds)
|
|
|
|
#### Schematics
|
|
|
|
| Project | Package | Version | Links |
|
|
|---|---|---|---|
|
|
**Angular PWA Schematics** | [`@angular/pwa`](https://npmjs.com/package/@angular/pwa) | [](https://npmjs.com/package/@angular/pwa) | [](https://github.com/angular/angular-pwa-builds)
|
|
**Angular Schematics** | [`@schematics/angular`](https://npmjs.com/package/@schematics/angular) | [](https://npmjs.com/package/@schematics/angular) | [](https://github.com/angular/schematics-angular-builds)
|
|
|
|
|
|
|
|
**Love Angular CLI? Give our repo a star :star: :arrow_up:.**
|
|
|
|
[contributing]: CONTRIBUTING.md
|
|
[developer]: docs/DEVELOPER.md
|
|
[quickstart]: https://angular.dev/tutorials/learn-angular
|
|
[changelog]: CHANGELOG.md
|
|
[documentation]: https://angular.dev/overview
|
|
[angularmaterial]: https://material.angular.io/
|
|
[cli]: https://angular.dev/tools/cli
|
|
[adev]: https://angular.dev/
|
|
[workspaceconfig]: https://angular.dev/reference/configs/workspace-config
|
|
[schematics]: https://angular.dev/tools/cli/schematics
|
|
[filestructure]: https://angular.dev/reference/configs/file-structure
|
|
[node.js]: https://nodejs.org/
|
|
[npm]: https://www.npmjs.com/get-npm
|
|
[codeofconduct]: https://github.com/angular/angular/blob/main/CODE_OF_CONDUCT.md
|
|
[twitter]: https://www.x.com/angular
|
|
[discord]: https://discord.gg/angular
|
|
[gitter]: https://gitter.im/angular/angular-cli
|
|
[stackoverflow]: https://stackoverflow.com/questions/tagged/angular-cli
|
|
[youtube]: https://youtube.com/angular
|
|
[meetup]: https://www.meetup.com/find/?keywords=angular
|