docs: update installation notes (#98)

* docs(editor): update installation notes and add docker notes

* chore(editor): update ga workflow filename

Author: tim-lai

.github/workflows/apidom-editor.yml renamed to .github/workflows/swagger-ide.yml

@@ -1,7 +1,7 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: ApiDOM Editor
+name: Swagger IDE
 
 on:
   push:

README.md

@@ -1,4 +1,4 @@
-# ApiDOM editor home
+# Swagger IDE
 
 App will load with Monaco, Topbar, Swagger-UI (react).
 
@@ -8,16 +8,29 @@ refer `docs/swagger-client.md` for some notes
 
 Webpack and development setup based on Create React App (ejected)
 
+## Prerequisites  
+```
+ "node": "~16.8",
+ "npm": ">=7.21.0"
+```
+
+- if using MacOS, please refer to additional installation notes below  
+- ApiDOM monorepo requires the use of `npm>=7.21.0`  
+
 ## Install
 
 After cloning run the following commands to init and update `apidom` submodule
 
-```
-git submodule init
-git submodule update
+```sh
+ $ git submodule init
+ $ git submodule update
 ```
 
-- (To update apidom submodule to latest commit, issue `git submodule update --recursive --remote`)  
+To update apidom submodule to latest commit, issue the following command:  
+
+```sh
+ $ git submodule update --recursive --remote
+```
 
 Change directory to `apidom` monorepo and run following commands:
 
@@ -28,7 +41,7 @@ Change directory to `apidom` monorepo and run following commands:
 
 Now change to root directory and run the following commands  
 
-```shell script
+```sh
  $ npm i
  $ npm start
 ```
@@ -37,6 +50,25 @@ Edit files in `./src` directory
 
 The default development port is `port=3000`. If a port is already in use, `npm start` will increment the port.  
 
+### MacOS Install notes
+
+With the combination of MacOS and Node.js 16, there is a known compatibility issue of installing and building the `tree-sitter` dependency. The workaround is to globally install `npm@7` (for lerna/apidom monorepo) but use Node.js 14 to install/build tree-sitter.  
+
+Although the prerequisite is to use [email protected], at this point we don't rely on any specific feature from Node.js 16 (except for `npm@7`).  
+
+```sh
+ $ npm install -g npm
+ $ npm --version 
+```
+
+Assuming we are using `NVM` to manage Node versions,  
+
+```sh
+ $ nvm use v14
+```
+
+Then follow the installation steps above  
+
 ## Test
 
 Both Jest and Cypress include `@testing-library` plugin support.  
@@ -102,3 +134,14 @@ This script will build and serve a gzipped static build at `localhost:3050`.
 $ npm run build
 $ npm run serve-static-build
 ```
+
+## Docker
+Once we build the app, we can also build and run a Docker container.  
+
+```sh
+ $ docker build . -t {{label}} 
+ $ docker run -p 8080:80 {{label}} 
+```
+
+- {{label}} can be any descriptive string, e.g. `user/myapp-1`  
+- open browser at `localhost:8080`