Ame NPM | npm.io

ame

Angular Made Easy (Angular 2, for humans)

Why does this exist?

Angular 2 is great in a whole range of ways, but the minimal examples out there are typically a dozen or more files and require developers to understand and combine many seperate elements in order to get even the most basic of examples working.

This package is intended to be a cross-browser compatible, simplified distribution of Angular 2 and all commonly required dependencies and soften the learning curve.

Version Tracking

I will try to maintain as close as possible a version parity with Angular 2. My repository is tracked by the awesome greenkeeper for dependencies, so in theory you'll never be more than a few days out. As this project does not modify any of the dependencies other than concatenating them, it means that you're able to switch seamlessly away from this library when you're ready.

Efficiency vs Simplicity

Yes. Including all of the components by default isn't 100% efficient. In fact the ame.min.js file is a whopping 970KB or so at last check. However, when served from a server with GZip compression support this drops to circa ~205KB, which is very easy to deal with for most scenarios.

In short, whilst you can make this more efficient by slotting in extra stuff like SystemJS or other components, the benefits are sufficiently nominal that this project. When you are ready to make that transition for your app, I fully encourage you to do so.

Version Choice

The files in /dist are:

ame.js (Full/uncompressed versions) - 2.7MB
ame.dev.js (Dev versions of components) - 6MB
ame.min.js (Minified versions of code, combined) - 1MB (200KB GZip)

Approximately 80-85% compression on suitable servers makes these sizes less problematic when starting out on your app development.

What's in the Bundle

The dependencies below are included in the bundling:

Core JS (Client Shims)
Zone.js
Reflect-Metadata
RxJS (Reactive Extensions)
Angular 2 Polyfills
Angular 2 (All Components)

A Real, Minimal Example

Examples are found in the Git Repository for this project under /examples - but here's a simplified version:

<html>
<head>
    <title>Angular 2 QuickStart JS</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!-- 1. Load libraries -->
    <script src='../../../dist/ame.min.js'></script>

    <!-- 2. Load our 'modules' -->
    <script src='app/app.component.js'></script>
    <script src='app/main.js'></script>
</head>
<!-- 3. Display the application -->
<body>
    <my-app>Loading...</my-app>
</body>
</html>

Where the path in (1) is your path to the ame file you wish to include.

Serving this Content

I'd recommend using a simple middleware setup (connect-mount/serve-static) in order to expose the ./node_modules/ame/dist/ folder on a suitable path inside your application.

angular angular2 easy bundle starter kit

@infinitebrahmanuniverse/nolb-ame @everything-registry/sub-chunk-1125 @zalastax/nolb-ame

8 years ago

8 years ago

8 years ago

8 years ago