Skip to content

all-contributors/architecture

Repository files navigation

All Contributors Software Architecture

Site: https://ac-architecture.netlify.app/

Introduction

This is a place where architectural diagrams of all the AC projects can be found.

It's currently focused on the new world (revamped) projects so it may not accurately illustrate the current systems.

This project was made with c4builder using C4-PlantUML diagrams based on Structurizr DSL exports.

Notes:

  • The diagrams use the C4 model.
  • Each containers (in the C4 sense) have their own repo (i.e. 1 container = 1 repo).

Diagrams

As per the C4 model, the diagrams go from a high level view (system context, level 1) to components (level 3, not files and classes as they are too low level and may frequently change), so it's recommended to go through them in their order of levels, so you can get a better understanding of the whole system.

But with the above in mind, most of you would get a good understanding of how All Contributors is structured and how each repositories fit into the overall picture by looking at the container diagram shown below: AC container diagram

The key elements are the containers such as the GitHub app (the bot), the CLI, the library (currently inexistent and integrated into the CLI and app), the website, the Deep Learning tool (AC-Learn) and the specification (currently inexistent and spread across the app, CLI and website).

Contributing

Cf. CONTRIBUTING.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Maximilian Berkmann

💻 📖 🤔 🚇 🚧

Gregor Martynus

🤔

Victor Lupu

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!