cleanup

README.md

@@ -11,17 +11,24 @@ However please be aware:
 * It would be nice to mention in radar that the generator is based on this repository.
 * Also when you want to reuse the CSS and Styling: Change the font (it is a licensed font) and the colors (It using AOE CI)
 
-## Installation
+## Use and build
 
+Add the tech radar as a dependency
 ```
-git clone git@github.com:AOEpeople/aoe_technology_radar.git
+yarn add https://github.com/aoepeople/aoe_technology_radar.git
-cd aoe_technology_radar
-yarn
-yarn watch
 ```
 
-_A new [browser tab](http://127.0.0.1:8080/techradar) should open up - wait
+Build the radar
-until last command has finished and refresh._
+```
+yarn aoe_technology_radar
+```
+
+Serve
+```
+cd build
+python3 -m http.server 8080
+```
+Then open here: http://localhost:8080
 
 ## Usage
 
@@ -62,27 +69,3 @@ 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.
-
-## Travis
-
-* [![Travis](https://api.travis-ci.org/AOEpeople/aoe_technology_radar.svg?branch=master)](https://travis-ci.org/AOEpeople/aoe_technology_radar/)
-  (master)
-
-* [![Travis](https://api.travis-ci.org/AOEpeople/aoe_technology_radar.svg?branch=next)](https://travis-ci.org/AOEpeople/aoe_technology_radar/)
-  (next)
-
-## Todos
-
-* [x] Add Icons
-* [x] Implement search
-* [ ] Finalize CSS
-* [x] Get contents for how-to-use page
-* [ ] Tagging Items (Show Tags / Linking related items automatically)
-* [ ] Filter by Tags in overview
-* [ ] Show item history on details (relevant with 2nd release)
-* [ ] Better semantic and SEO
-* [ ] Make mobile friendly
-* [ ] Add mobile navigation and search
-* [ ] Create more react components for already existing CSS comps
-* [ ] Refactor hardcoded subfolder in routing
-* [ ] Unit test for radar generation :see_no_evil:

bin/tasks/radarjson.js

@@ -10,9 +10,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.radarJsonGenerator = void 0;
 const radar_1 = require("./radar");
 const file_1 = require("./file");
-(() => __awaiter(void 0, void 0, void 0, function* () {
+exports.radarJsonGenerator = (() => __awaiter(void 0, void 0, void 0, function* () {
     try {
         console.log('start');
         const radar = yield radar_1.createRadar();
@@ -42,4 +43,4 @@ ReactDOM.render(
     catch (e) {
         console.error('error:', e);
     }
-}))();
+}));

package.json

@@ -7,8 +7,7 @@
     "build": "tsc"
   },
   "bin": {
-    "aoe-radar-create": "bin/tasks/radarjson.js",
+    "aoe_technology_radar": "scripts/build.js"
-    "aoe-radar-build": "scripts/build.js"
   },
   "browserslist": {
     "production": [

scripts/build.js

@@ -13,6 +13,10 @@ process.on('unhandledRejection', err => {
   throw err;
 });
 
+// create radar
+
+require('../bin/tasks/radarjson').radarJsonGenerator()
+
 // Ensure environment variables are read.
 require('../config/env');
 

tasks/radarjson.ts

@@ -4,7 +4,7 @@ import {createRadar} from "./radar";
 import {save} from "./file";
 
 
-(async () => {
+export const radarJsonGenerator = (async () => {
     try {
         console.log('start')
         const radar = await createRadar();
@@ -37,4 +37,4 @@ ReactDOM.render(
     } catch (e) {
         console.error('error:', e);
     }
-})()
+})