Exemplary real world application built with Aurelia
Switch branches/tags
Nothing to show
Clone or download
Latest commit a79ca2b Jun 16, 2018

README.md

Build Status

RealWorld Example App

Aurelia codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged fullstack application built with Aurelia including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Aurelia community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Community Activity

How it works

Created with aurelia-cli

Getting started

Make sure you have Node and Yarn installed. Then run

yarn install
au run --watch

and Navigate to http://localhost:8080/.

The app will automatically reload if you change any of the source files.

Building the project

Run au build to build the project. The build artifacts will be stored in the dist/ directory. Use the --env prod flag for a production build.

Testing the project

Run au karma to test the project.

Functionality overview

The example application is a social blogging site (i.e. a Medium.com clone) called "Conduit". It uses a custom API for all requests, including authentication.

General functionality:

  • Authenticate users via JWT (login/signup pages + logout button on settings page)
  • CRU* users (sign up & settings page - no deleting required)
  • CRUD Articles
  • CR*D Comments on articles (no updating required)
  • GET and display paginated lists of articles
  • Favorite articles
  • Follow other users

The general page breakdown looks like this:

  • Home page (URL: /#/ )
    • List of tags
    • List of articles pulled from either Feed, Global, or by Tag
    • Pagination for list of articles
  • Sign in/Sign up pages (URL: /#/login, /#/register )
    • Uses JWT (store the token in localStorage)
    • Authentication can be easily switched to session/cookie based
  • Settings page (URL: /#/settings )
  • Editor page to create/edit articles (URL: /#/editor, /#/editor/article-slug-here )
  • Article page (URL: /#/article/article-slug-here )
    • Delete article button (only shown to article's author)
    • Render markdown from server client side
    • Comments section at bottom of page
    • Delete comment button (only shown to comment's author)
  • Profile page (URL: /#/profile/:username, /#/profile/:username/favorites )
    • Show basic user info
    • List of articles populated from author's created articles or author's favorited articles

IE 11 Support

In order to optimize the app for IE11 or Edge please add bluebird.js as a polyfill for Promises and Fetch.


Brought to you by Thinkster