headlamp-build: Add package.json for scripts from Makefile

This is to simplify using Headlamp so that people do not need to
have installed gnu Make. Which isn't on Windows, and isn't on
some Mac/unix systems.

Just starting with the start script, the rest can come later.

This package is not intended to be published, and so the name is
not important at this stage.

Signed-off-by: René Dudfield <renedudfield@microsoft.com>

app/scripts/start.js

@@ -6,7 +6,7 @@
  */
 const { spawn } = require('child_process');
 
-const serverProcess = spawn('cd ../ && make backend && make run-backend', [], {
+const serverProcess = spawn('cd ../ && npm run build:backend && npm run backend', [], {
   stdio: 'inherit',
   shell: true,
 });

docs/development/index.md

@@ -19,6 +19,16 @@ These are the required dependencies to get started. Other dependencies are pulle
 - [Make](https://www.gnu.org/software/make/) (GNU). Often installed by default. On Windows this can be installed with the "chocolatey" package manager that is installed with node.
 - [Kubernetes](https://kubernetes.io/), we suggest [minikube](https://minikube.sigs.k8s.io/docs/) as one good K8s installation for testing locally. Other k8s installations are supported (see [platforms](../platforms.md).
 
+## Run the app
+
+`npm start`
+
+This will run back the backend, the frontend in development mode, and the app in development mode.
+
+This is the quickest way to get started and see if everything is working. It may take a while to get going the first time as it installs things and warms up.
+
+See below for running the frontend and backend separately to work in the web browser which is more convenient than developing in the app.
+
 ## Build the code
 
 Headlamp is composed of a `backend` and a `frontend`.

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@headlamp-k8s/headlamp-build",
+  "version": "0.0.1",
+  "description": "Use 'npm start' to get going quickly. See contrib guide docs for more info. For building and running Headlamp without Make.",
+  "directories": {
+    "doc": "docs"
+  },
+  "scripts": {
+    "start": "cd app && npm start",
+    "backend": "npm install && cross-env HEADLAMP_BACKEND_TOKEN=headlamp HEADLAMP_CONFIG_ENABLE_HELM=true HEADLAMP_CONFIG_ENABLE_DYNAMIC_CLUSTERS=true ./backend/headlamp-server -dev -proxy-urls https://artifacthub.io/* -enable-dynamic-clusters",
+    "build:backend": "cd backend && go build -o ./headlamp-server${SERVER_EXE_EXT} ./cmd"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/headlamp-k8s/headlamp.git"
+  },
+  "keywords": [
+    "headlamp",
+    "kubernetes"
+  ],
+  "author": "Headlamp devs",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/headlamp-k8s/headlamp/issues"
+  },
+  "homepage": "https://github.com/headlamp-k8s/headlamp#readme"
+}