Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3.08 KB

README.md

File metadata and controls

88 lines (63 loc) · 3.08 KB
Raw

Neofonie TechRadar

Build Status

Screenshot

Motivation

At Neofonie, we maintain a public Tech Radar to help our engineering teams align on technology choices. It is based on the pioneering work by ThoughtWorks and Zalando.

This repository is a ES6 refactoring.

Usage

1. install

git clone https://github.com/Neofonie/tech-radar.git
cd tech-radar
npm install

2. start local dev server

Open the url: http://localhost:9000

npm run dev

3. make build

Create some distribution files in: /dist and copy it to /docs
At the moment - it is a must. Later we will use TravisCI. Then this step is obsolete.

npm run build

The Difference between the /dist and the /docs folder are the different url paths in the css files. The /docs folder is only for github pages.

The Data

  • must be served by a server
  • will be loaded as fetch request
  • is mainly located in public/data/ - edit these files
  • public/data/ will be copied to the dist/ and docs/ folder on a npm run build
  • the all over data index is public/data/index.json
  • any data group is represented by a folder like public/data/neofonie/
  • in this folder there is a config file for the group public/data/neofonie/config.json
  • any group can have unlimited datasets.
  • the dataset filename without the file extension must be an entry in public/data/index.json in "versions": ["2019.10", "2019.05"]

The Theme

  • take a look in the webpack config, there are multiple entry points for the css
  • a theme override the default css. it is a second css file that will be injected
  • any theme css has a root scss file like src/scss/dark.scss or src/scss/forest.scss

License

The MIT License (MIT)

Copyright (c) 2022 Neofonie GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.