Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 1.75 KB

README.md

File metadata and controls

66 lines (45 loc) · 1.75 KB
Raw

RedMadRobot Technology Radar

RedMadRobot Technology Radar, inspired by AOE TechRadar

Build the radar

Build the radar

npm i
npm run serve

Build the radar with static files

npm i
npm run build

Then open here: http://localhost:3000/techradar-android/

Usage

For a new Technology Radar release, create a folder of the release date (YYYY-MM-DD) under radar/, or use:

npm run newReleaseFolder

Maintaining items

The items are written in Markdown format (.md)

Each file has a front-matter header where the attributes of the item are listed:

---
title:      "React"
ring:       adopt
quadrant:   languages-and-frameworks
---

Text goes here. You can use markdown here.

Following front-matter attributes are possible:

  • title: Name of the Item
  • quadrant: Quadrant. One of libraries, methods-and-patterns, languages-and-frameworks, utilities
  • ring: Ring section in radar. One of trial, assess, adopt, hold
  • tags: Optional tags for filtering
  • featured: (optional, default "true") If you set this to false, the item will not be visible in the radar quadrants but still be available in the overview.

The name of the .md file acts as item identifier and may overwrite items with the same name from older releases.

If an item is overwritten in a new release, the attributes from the new item are merged with the old ones, and a new history entry is created for that item.

You can integrate images in your markdown. Put the image files in your public/images/ folder and reference them:

![nice image](/images/nice-image.png)