update to use netlify cli for local

thisisjofrank · thisisjofrank · commit baf7a1cb3509 · 2022-08-15T16:30:02.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -104,3 +104,5 @@ dist
 .tern-port
 
 /public/build
+
+.netlify
diff --git a/README.MD b/README.MD
@@ -104,17 +104,18 @@ You can repeat these steps repository-by-repository if you prefer.
 
 ## Local Development
 
-To run the app locally, once cloned, you will need to create an `.env` file in `/api` directory to configure your `ABLY_API_KEY` and `GITHUB_WEBHOOK_SECRET`:
+To run the app locally, once cloned, you will need to create an `.env` file in root directory, to configure your `ABLY_API_KEY` and `GITHUB_WEBHOOK_SECRET`:
 
 ```bash
 ABLY_API_KEY=your-ably-api-key
 GITHUB_WEBHOOK_SECRET=a-secret-password-that-you-make-up
 ```
 
-Local dev uses **vite** as a development server, firstly install the dependencies then run the start script:
+Next install the Netlify CLI, to run the serverless functions locally, then install the dependencies and run the start script:
 
 ```bash
-npm i
+npm install netlify-cli -g
+npm install
 npm run start
 ```
 
diff --git a/app/index.html b/app/index.html
@@ -5,7 +5,7 @@
 	<meta charset='utf-8'>
 	<meta name='viewport' content='width=device-width,initial-scale=1'>
 
-	<title>GitHub Commit Visualiser by Ably</title>
+	<title>GitHub Commit Visualizer by Ably</title>
 
 	<link rel='icon' type='image/png' href='/favicon.ico'>
 	<link rel='stylesheet' href='/global.css'>
diff --git a/package.json b/package.json
@@ -5,11 +5,12 @@
   "type": "module",
   "scripts": {
     "prestart": "cd api && npm install",
-    "start": "run-p dev:api dev:app",
+    "start": "netlify dev -c \"npm run dev:app\" --targetPort 8080",
     "dev:app": "vite",
     "dev:api": "npm run start --prefix api",
     "test": "vitest run",
     "check": "svelte-check --tsconfig ./tsconfig.json",
+    "start:azure": "run-p dev:api dev:app",
     "build:azure": "npx vite build",
     "build:netlify": "npx vite build && cd api && npm i && npm run build"
   },
