https://github.com/redmadrobot/techradar-android
RMR Technology Radar
https://github.com/redmadrobot/techradar-android
Last synced: about 1 year ago
JSON representation
RMR Technology Radar
- Host: GitHub
- URL: https://github.com/redmadrobot/techradar-android
- Owner: RedMadRobot
- License: other
- Created: 2022-04-14T09:22:33.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T16:35:09.000Z (about 2 years ago)
- Last Synced: 2024-04-24T19:14:07.737Z (about 2 years ago)
- Language: Kotlin
- Homepage: https://redmadrobot.github.io/techradar-android/
- Size: 2.06 MB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: License
Awesome Lists containing this project
README
# RedMadRobot Technology Radar
RedMadRobot Technology Radar, inspired by [AOE TechRadar](https://www.aoe.com/techradar/index.html)
## Build the radar
Build the radar
```bash
npm i
npm run serve
```
Build the radar with static files
```bash
npm i
npm run build
```
Then open here: [http://localhost:3000/techradar-android/](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:
```bash
npm run newReleaseFolder
```
## Maintaining items
The items are written in Markdown format (.md)
Each file has a [front-matter](https://github.com/jxson/front-matter) header where the attributes of the item are listed:
```Markdown
---
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:
```Markdown
```