Explain more in the Readme.md to make local development easier.

This commit is contained in:
dennis.ludwig
2021-06-21 14:49:05 +02:00
parent 1109b3d328
commit 01500682f7

View File

@@ -1,19 +1,29 @@
# AOE Technology Radar
## Generate json file of the markdown files
## Development
### Host the application under a sub path
To host the application under a sub path, set the environment variable `PUBLIC_URL`, e.g. "/techradar". The default is "/techradar".
For local development I recommend using "/build" and use this for the following steps.
### Build the radar
```
yarn build
python3 -m http.server 8080
```
Then open here: http://localhost:8080/build
### Build the radar with static files
```
yarn build:static
python3 -m http.server 8080
```
Then open here: http://localhost:8080/build
### Regenerate the json file based on your changes on md files
```
yarn generateJson
```
## Build the radar
```
yarn build
```
## Serve
```
cd build
python3 -m http.server 8080
```
Then open here: http://localhost:8080
You can do this while the server is running. You can find the newly created rd.json in "/build/rd.json".