aurelia/framework

★ 11,683TypeScriptAudience · developerComplexity · 3/5LicenseSetup · moderate

Mindmap

mindmap
  root((Aurelia 1))
    What it does
      Web app framework
      Data binding
      Component system
    Features
      Routing
      Dependency injection
      Internationalization
    Design approach
      Convention over config
      Standard web specs
      Plain JS classes
    Audience
      Web developers
      SPA builders
      JS framework users

mindmap root((Aurelia 1)) What it does Web app framework Data binding Component system Features Routing Dependency injection Internationalization Design approach Convention over config Standard web specs Plain JS classes Audience Web developers SPA builders JS framework users

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Build a single-page web application with routing, data binding, and validation using plain JavaScript classes paired with HTML templates.

USE CASE 2

Add server-side rendering or internationalization to an Aurelia app using its built-in support modules without third-party plugins.

USE CASE 3

Scaffold a new multi-screen Aurelia app with the Aurelia CLI and organize it into components that link logic and UI by naming convention.

Tech stack

TypeScriptJavaScriptHTML

Getting it running

Difficulty · moderate Time to first run · 30min

This repo is Aurelia 1 (the older version), Aurelia 2 exists separately with a different architecture, make sure you pick the right one.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice (MIT).

In plain English

Aurelia is a JavaScript framework for building web applications that run in the browser. It can also be used to build desktop and mobile apps. This particular repository is the entry point for Aurelia 1, the original version of the framework. It pulls together all the separate Aurelia pieces into a single package so a developer can start building without having to install each piece individually. The framework is built around the concept of components. Each component in an Aurelia app consists of two files: a plain JavaScript or TypeScript class that holds the logic, and an HTML template that handles what the user sees. The two are linked by naming convention rather than requiring the developer to write explicit wiring code. The HTML templates support a binding syntax that connects what is displayed to the data in the JavaScript class, so when data changes, the screen updates automatically. Aurelia's stated goal is to stay out of your way. The team designed it to align with standard web browser behavior and specifications rather than inventing its own patterns. Developers who know standard JavaScript and HTML should be able to read and write Aurelia code without learning many framework-specific concepts. The framework includes support for routing (navigating between different screens), data binding, dependency injection (a way to manage how different parts of an app share resources), validation, internationalization, and server-side rendering. A command-line tool called the Aurelia CLI is available to help create and build projects. Note that this repository covers Aurelia 1, which is the older release. A separate Aurelia 2 exists with a different architecture. The project is open source under the MIT license.

Copy-paste prompts

Prompt 1

Create a simple Aurelia 1 app with two routes, a home page and a contact form, using the Aurelia CLI, and show me the resulting folder structure.

Prompt 2

Show me how to bind a JavaScript class property to an input field in Aurelia 1 so the displayed value updates live as the user types.

Prompt 3

Set up dependency injection in Aurelia 1 to share a user authentication service across multiple components without passing it manually as a parameter.

Prompt 4

Migrate a simple Aurelia 1 component to TypeScript decorators and explain what each decorator does.

Open on GitHub → Explain another repo

← aurelia on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.