Add Archify | New Model… with three C4 examples and Open Model in the Explorer menu
- templates/models: C4 - Standard Web App, C4 - E-Shop, C4 - Event-Based Integration; each a complete model (main.archify, registry, context, containers, components) that validates - archify.newModel: pick an example and a folder name, copy it, name the model after the folder, open the model page - Explorer menu: New Model… on folders, Open Model on .archify and .archify-registry files; File → New File… lists New Model… - unit test validates every example end to end; integration test runs the command; README, CHANGELOG, docs/model.md
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: System context
|
||||
output: context.html
|
||||
components:
|
||||
- ref: user
|
||||
pos: [40, 60]
|
||||
size: [130, 60]
|
||||
- ref: admin
|
||||
pos: [40, 260]
|
||||
size: [130, 60]
|
||||
- ref: webapp
|
||||
pos: [280, 160]
|
||||
size: [160, 60]
|
||||
- ref: idp
|
||||
pos: [530, 60]
|
||||
size: [150, 60]
|
||||
- ref: email
|
||||
pos: [530, 260]
|
||||
size: [150, 60]
|
||||
connections:
|
||||
- { from: user, to: webapp, label: uses, variant: emphasis }
|
||||
- { from: admin, to: webapp, label: administers }
|
||||
- { from: webapp, to: idp, label: signs in via, variant: security }
|
||||
- { from: webapp, to: email, label: sends mail }
|
||||
@@ -0,0 +1,38 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: Containers
|
||||
output: containers.html
|
||||
components:
|
||||
- ref: user
|
||||
pos: [40, 160]
|
||||
size: [130, 60]
|
||||
- ref: spa
|
||||
pos: [250, 160]
|
||||
size: [150, 60]
|
||||
- ref: api
|
||||
pos: [480, 160]
|
||||
size: [130, 60]
|
||||
- ref: idp
|
||||
pos: [480, 20]
|
||||
size: [130, 60]
|
||||
- ref: cache
|
||||
pos: [690, 60]
|
||||
size: [130, 60]
|
||||
- ref: db
|
||||
pos: [690, 160]
|
||||
size: [130, 60]
|
||||
- ref: storage
|
||||
pos: [690, 260]
|
||||
size: [130, 60]
|
||||
boundaries:
|
||||
- kind: region
|
||||
label: Web Application
|
||||
wraps: [spa, api, cache, db, storage]
|
||||
connections:
|
||||
- { from: user, to: spa, label: HTTPS, variant: emphasis }
|
||||
- { from: spa, to: api, label: JSON }
|
||||
- { from: api, to: idp, label: verify token, variant: security, labelAt: [531, 110] }
|
||||
- { from: api, to: cache, label: read }
|
||||
- { from: api, to: db, label: SQL }
|
||||
- { from: api, to: storage, label: files }
|
||||
@@ -0,0 +1,42 @@
|
||||
schema_version: 1
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: API components
|
||||
output: api.html
|
||||
components:
|
||||
- ref: spa
|
||||
pos: [40, 160]
|
||||
size: [150, 60]
|
||||
- id: auth
|
||||
type: security
|
||||
label: Auth
|
||||
sublabel: token check
|
||||
pos: [270, 40]
|
||||
size: [130, 60]
|
||||
- id: accounts
|
||||
type: backend
|
||||
label: Accounts
|
||||
pos: [270, 160]
|
||||
size: [130, 60]
|
||||
- id: content
|
||||
type: backend
|
||||
label: Content
|
||||
pos: [270, 280]
|
||||
size: [130, 60]
|
||||
- ref: db
|
||||
pos: [500, 160]
|
||||
size: [130, 60]
|
||||
- ref: storage
|
||||
pos: [500, 280]
|
||||
size: [130, 60]
|
||||
boundaries:
|
||||
- kind: region
|
||||
label: API
|
||||
wraps: [auth, accounts, content]
|
||||
connections:
|
||||
- { from: spa, to: auth, label: token, variant: security }
|
||||
- { from: spa, to: accounts, label: profile }
|
||||
- { from: spa, to: content, label: pages }
|
||||
- { from: accounts, to: db, label: SQL }
|
||||
- { from: content, to: db, label: SQL }
|
||||
- { from: content, to: storage, label: files }
|
||||
@@ -0,0 +1,29 @@
|
||||
schema_version: 1
|
||||
model:
|
||||
id: standard-web-app
|
||||
name: Standard Web App
|
||||
description: >
|
||||
A classic web application; a single-page app, an API, a database,
|
||||
a cache and file storage, with sign-in through an identity provider.
|
||||
Context, containers and the API's components, C4 style.
|
||||
diagram_type: architecture
|
||||
meta:
|
||||
title: Standard Web App — overview
|
||||
output: main.html
|
||||
components:
|
||||
- ref: user
|
||||
pos: [40, 160]
|
||||
size: [130, 60]
|
||||
- ref: webapp
|
||||
pos: [250, 160]
|
||||
size: [160, 60]
|
||||
- ref: idp
|
||||
pos: [490, 60]
|
||||
size: [150, 60]
|
||||
- ref: email
|
||||
pos: [490, 260]
|
||||
size: [150, 60]
|
||||
connections:
|
||||
- { from: user, to: webapp, label: uses, variant: emphasis }
|
||||
- { from: webapp, to: idp, label: signs in via, variant: security }
|
||||
- { from: webapp, to: email, label: sends mail }
|
||||
@@ -0,0 +1,32 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
spa:
|
||||
type: frontend
|
||||
label: Single-page app
|
||||
sublabel: React
|
||||
brand: react
|
||||
description: The user interface; talks only to the API.
|
||||
api:
|
||||
type: backend
|
||||
label: API
|
||||
sublabel: Node.js
|
||||
brand: node-js
|
||||
description: Owns accounts, content and files; checks tokens from the identity provider.
|
||||
diagram: 0300-components/api.archify
|
||||
db:
|
||||
type: database
|
||||
label: Database
|
||||
sublabel: PostgreSQL
|
||||
brand: postgresql
|
||||
description: Accounts and content; the source of truth.
|
||||
cache:
|
||||
type: database
|
||||
label: Cache
|
||||
sublabel: Redis
|
||||
brand: redis
|
||||
description: Sessions and hot content; safe to lose.
|
||||
storage:
|
||||
type: cloud
|
||||
label: Object storage
|
||||
sublabel: uploaded files
|
||||
description: User uploads and generated exports.
|
||||
@@ -0,0 +1,12 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
user:
|
||||
type: external
|
||||
label: User
|
||||
sublabel: browser
|
||||
description: Anyone with an account; uses the application from a browser.
|
||||
admin:
|
||||
type: external
|
||||
label: Administrator
|
||||
sublabel: back office
|
||||
description: Manages users and content from the same application with extra rights.
|
||||
@@ -0,0 +1,18 @@
|
||||
schema_version: 1
|
||||
elements:
|
||||
webapp:
|
||||
type: cloud
|
||||
label: Web Application
|
||||
sublabel: the system
|
||||
description: Everything we build and run; the single-page app, the API and its stores.
|
||||
diagram: 0200-containers/web-app.archify
|
||||
idp:
|
||||
type: external
|
||||
label: Identity provider
|
||||
sublabel: OpenID Connect
|
||||
description: Signs users in and issues tokens; we never store passwords.
|
||||
email:
|
||||
type: external
|
||||
label: Email service
|
||||
sublabel: transactional mail
|
||||
description: Sends sign-up confirmations and notifications.
|
||||
Reference in New Issue
Block a user