https://github.com/ryepup/c4-lab

web interface to create diagrams expressing a software architecture
https://github.com/ryepup/c4-lab

architecture documentation-tool

Last synced: about 1 month ago
JSON representation

web interface to create diagrams expressing a software architecture

• Host: GitHub
• URL: https://github.com/ryepup/c4-lab
• Owner: ryepup
• License: mit
• Created: 2016-01-03T16:18:00.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T17:42:19.000Z (about 2 years ago)
• Last Synced: 2024-04-09T18:05:06.413Z (9 months ago)
• Topics: architecture, documentation-tool
• Language: TypeScript
• Size: 9.54 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.