ryepup/c4-lab

# c4-lab

`c4-lab` is a web interface to create diagrams expressing a software
architecture, and share those as images and text-based data.

[![Build Status](https://travis-ci.org/ryepup/c4-lab.svg?branch=master)](https://travis-ci.org/ryepup/c4-lab)
[![Code Climate](https://codeclimate.com/github/ryepup/c4-lab/badges/gpa.svg)](https://codeclimate.com/github/ryepup/c4-lab)
[![Test Coverage](https://codeclimate.com/github/ryepup/c4-lab/badges/coverage.svg)](https://codeclimate.com/github/ryepup/c4-lab/coverage)
[![Issue Count](https://codeclimate.com/github/ryepup/c4-lab/badges/issue_count.svg)](https://codeclimate.com/github/ryepup/c4-lab)

`c4-lab` is a based on [Simon Brown][SB]'s [C4][] approach (Context,
Containers, Components, and Classes). See
[Visualising Software Architecture][] for more information.

[SB]: http://www.simonbrown.je/
[C4]: http://www.codingthearchitecture.com/2014/08/24/c4_model_poster.html
[Visualising Software Architecture]: https://leanpub.com/visualising-software-architecture

The latest version is deployed at https://ryepup.github.io/c4-lab


## Getting started

`c4-lab` uses yarn to install dependencies and as a task runner. To develop:

    yarn install
    yarn start

See architecture decision records in `doc/adr`

## Contributing

Pull requests are welcome.