README-TEMPLATE.md

<%- lib.renderOpening() %>

Background

Agile Avatars makes it quick and easy to know who's working on what with great looking avatars for your agile board. No more fiddling with Word or Google Docs making sure everything aligns just right. Simply drag and drop your images, make some adjustments, print, and laminate!

<%- await lib.renderImage('readme-files/demo.gif', 'Agile Avatars in action') %>

Agile Avatars is also an experiment in developing a web application under an extreme set of constraints designed to preclude mainstream solutions. Bare in mind that Agile Avatars is small and doesn't necessarily cover every concern found in a typical web application. It does however do enough to present some interesting design challenges, especially around code organisation, dependency management, state management and view rendering.

The solutions are designed around the needs of this application at this point in time. The design is intended to be evolvable through refactoring as the needs of the application change over time. The intent is to see what kind of design emerges as a result of an extreme set of constraints.

Getting Started

<%- await include('./readme-gen/assets/sections/getting-started.md') %>

Design Goals

<%- await include('./readme-gen/assets/sections/design-goals.md') %>

Technical Constraints

<%- await include('./readme-gen/assets/sections/technical-constraints.md') %>

Architecture

<%- await include('./readme-gen/assets/sections/architecture.md') %>

Launching

<%- await include('./readme-gen/assets/sections/launching.md') %>

Composing

<%- await include('./readme-gen/assets/sections/composing.md') %>

Modules

<%- await include('./readme-gen/assets/sections/modules.md') %>

List of Modules

Following is a complete list of modules in Agile Avatars.

The diff-like block lists the collaborators in green and the non-collaborators in red.

<%- await lib.renderModules() %>

State Management

<%- await include('./readme-gen/assets/sections/state-management.md') %>

View Rendering

<%- await include('./readme-gen/assets/sections/view-rendering.md') %>

Testing

<%- await include('./readme-gen/assets/sections/testing.md') %>

Dependencies

<%- await include('./readme-gen/assets/sections/dependencies.md') %>

List of Production Dependencies

<%- await lib.renderDependencies('dependencies') %>

List of Development Dependencies

<%- await lib.renderDependencies('devDependencies') %>

Functional Programming

<%- await include('./readme-gen/assets/sections/functional-programming.md') %>

Conventions

<%- await include('./readme-gen/assets/sections/conventions.md') %>