framework README

The project's README from github.com/aurelia/framework. As one markdown file: README.md.

Aurelia

License: MIT npm Version ci Discourse status Twitter Discord Chat

aurelia-framework

Aurelia is a modern, front-end JavaScript framework for building browser, mobile, and desktop applications. It focuses on aligning closely with web platform specifications, using convention over configuration, and having minimal framework intrusion. Basically, we want you to just write your code without the framework getting in your way. :wink:

This library is part of the Aurelia platform. It contains the aurelia-framework library, which brings together all the required core aurelia libraries into a ready-to-go application-building platform.

Aurelia applications are built by composing a series of simple components. By convention, components are made up of a vanilla JavaScript or Typescript class, with a corresponding HTML template. 

//app.js
export class App {
  welcome = "Welcome to Aurelia";

  quests = [
    "To seek the holy grail",
    "To take the ring to Mordor",
    "To rescue princess Leia"
  ];
}

<!-- app.html -->
<template>
  <form>
    <label for="name-field">What is your name?</label>
    <input id="name-field" value.bind="name & debounce:500">

    <label for="quest-field">What is your quest?</label>
    <select id="quest-field" value.bind="quest">
      <option></option>
      <option repeat.for="q of quests">${q}</option>
    </select>
  </form>

  <p if.bind="name">${welcome}, ${name}!</p>
  <p if.bind="quest">Now set forth ${quest.toLowerCase()}!</p>
</template>

Check out the interactive version of this example on Code Sandbox.

This example shows you some of the powerful features of the aurelia binding syntax. To see further examples, online playgrounds, guides, and detailed API documentation, head on over to aurelia.io.

Feeling excited? To quickly get started building your project with aurelia, you can use the aurelia CLI.

Documentation

You can read the documentation for the aurelia framework here. It's divided into the following sections:

You can improve the documentation by contributing to this repository.

Staying Up-to-Date

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter.

Questions

If you have questions, join us in our dedicated discourse forum or submit questions on stack overflow.

Contributing

We'd love for you to contribute and help make Aurelia even better than it is today! You can start by checking out our contributing guide, which has everything you need to get up and running.

License

Aurelia is MIT licensed. You can find out more and read the license document here.

framework (aurelia/framework)

Searching Database…

11.7K ·GitHub
Framework
What is this?Aurelia is a modern front-end JavaScript framework for building browser, mobile, and desktop applications. This repo is the 1.x entry point that assembles the whole platform.
Is this one library among many, or the whole framework in a single package?It's the framework's entry-point package: aurelia-framework bundles all required core Aurelia libraries — binding, templating, dependency injection and more — into one ready-to-use platform.
How do I get started building an app with it?The quickest route is the Aurelia CLI, which scaffolds and builds your project; the docs also cover building directly with Webpack or JSPM if you'd rather skip the CLI.
Do I have to write TypeScript, or does plain JavaScript work too?Either works. By convention a component is a vanilla JavaScript or TypeScript class paired with an HTML template, so you can start in plain JS and adopt TypeScript later.
Is this strictly for single-page web apps?Single-page browser apps are the typical use, but the framework is explicitly aimed at mobile and desktop applications too.
Is it free to use, even in commercial projects?Yes — Aurelia is MIT licensed, so you can use, modify, and ship it commercially without restrictions.
What makes Aurelia different from other front-end frameworks?Its pitch is convention over configuration, close alignment with web platform specifications, and minimal framework intrusion — the idea is that you just write your code without the framework getting in the way.
Which plugins ship officially with the framework?The docs cover official plugins for validation, i18n, http, dialog, and state management, plus a router with setup and configuration guidance.
Can I render my app on the server?Yes — the documentation has a dedicated Server Side Rendering section explaining how to configure an Aurelia project for SSR.
How do I test an Aurelia application?The docs cover both component testing and end-to-end testing; the framework repo itself runs its own suite with Karma.
What are similar projects?angular.js, vue, ice, getx, nuqs, single-spa, router, nuxt
Which topics is it in?spa, dependency-injection, routing, validation, ssr, frontend-framework, state-management, webpack, i18n, http, javascript-library, testing
Creator
aurelia
Size
3.2 MB
Stars
11.7K
Updated
CommitAug 26Release1.4.1Mar 31
Age
11y
Commits · 90 Days