angular / angular-component-spec

Specification for reusable AngularJS components

Angular - The modern web developer's platform

Angular is a development platform for building mobile and desktop web applications
using TypeScript/JavaScript and other languages.

angular.dev

Contributing Guidelines · Submit an Issue · Blog

   

---

Documentation

Get started with Angular, learn the fundamentals and explore advanced topics on our documentation website.

• Getting Started
• Architecture
• Components and Templates
• Forms
• API

Advanced

• Angular Elements
• Server Side Rendering
• Schematics
• Lazy Loading
• Animations

Local Development

To contribute to Angular docs, you can setup a local environment with the following commands:

# Clone Angular repo
git clone https://github.com/angular/angular.git

# Navigate to project directory
cd angular

# Install dependencies
yarn

# Build and run local dev server
# Note: Initial build will take some time
yarn docs

Development Setup

Prerequisites

• Install Node.js which includes Node Package Manager

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.

Ecosystem

• Angular Command Line (CLI)
• Angular Material

Changelog

Learn about the latest improvements.

Upgrading

Check out our upgrade guide to find out the best way to upgrade your project.

Contributing

Contributing Guidelines

Read through our contributing guidelines to learn about our submission process, coding rules, and more.

Want to Help?

Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our Code of Conduct.

Community

Join the conversation and help the community.

• X (formerly Twitter)
• Discord
• Gitter
• YouTube
• StackOverflow
• Find a Local Meetup

Love Angular? Give our repo a star ⭐ ⬆️.

angular-component-spec's Issues

Add instructions for publishing to npm

We decided that we prefer npm to bower. We should update this guide accordingly.

We should still preserve the bower install instructions, and encourage developers to support both as best as they can.

Purpose?

What is the purpose of this spec? Or is that also a WIP?

The reason I ask is because I didn't know about this repo until a couple of hours ago. Not having any standard blueprint or conventions for angular development has been bothering me. My response to this earlier this morning, not knowing about this repo, was to start https://github.com/mikehaas763/angular-conventions.

I now see that the repo I started may A) be completely redundant or B) have overlap with this repository/spec. Obviously, I mentioned on that repo's readme about figuring out how to organize into a proper component for bower. However, my main goal and hope is to get an overall application structure for the developing in the framework. Not just individual components.

So ultimately, is angular-component-spec just for defining how to make smaller modular components that still need to be "plugged in" to an applications structure?

P.S. Getting solid framework application structure conventions whether official or just well accepted by the community is something I really care about at this point. So let's keep these discussions going.

Decide what to do with this repo

We haven't touched this in months, but I think there are valuable things in here.

I vote we move this content into the official angular docs.

Recently, we get a lot of PRs for new features that should be implemented as third-party modules instead. Having a canonical explanation for how to do this would be nice.