Commit baf7a1c

committed

update to use netlify cli for local

1 parent 3097656 commit baf7a1cCopy full SHA for baf7a1c

File tree

-5

lines changed

-5

lines changed

Lines changed: 2 additions & 0 deletions

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -104,17 +104,18 @@ You can repeat these steps repository-by-repository if you prefer.`
`104`	`104`
`105`	`105`	`## Local Development`
`106`	`106`
`107`		-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`:
	`107`	+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`:
`108`	`108`
`109`	`109`	```bash
`110`	`110`	`ABLY_API_KEY=your-ably-api-key`
`111`	`111`	`GITHUB_WEBHOOK_SECRET=a-secret-password-that-you-make-up`
`112`	`112`	```
`113`	`113`
`114`		`-Local dev uses vite as a development server, firstly install the dependencies then run the start script:`
	`114`	`+Next install the Netlify CLI, to run the serverless functions locally, then install the dependencies and run the start script:`
`115`	`115`
`116`	`116`	```bash
`117`		`-npm i`
	`117`	`+npm install netlify-cli -g`
	`118`	`+npm install`
`118`	`119`	`npm run start`
`119`	`120`	```
`120`	`121`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`<meta charset='utf-8'>`
`6`	`6`	`<meta name='viewport' content='width=device-width,initial-scale=1'>`
`7`	`7`
`8`		`- <title>GitHub Commit Visualiser by Ably</title>`
	`8`	`+ <title>GitHub Commit Visualizer by Ably</title>`
`9`	`9`
`10`	`10`	`<link rel='icon' type='image/png' href='/favicon.ico'>`
`11`	`11`	`<link rel='stylesheet' href='/global.css'>`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,12 @@`
`5`	`5`	`"type": "module",`
`6`	`6`	`"scripts": {`
`7`	`7`	`"prestart": "cd api && npm install",`
`8`		`- "start": "run-p dev:api dev:app",`
	`8`	`+ "start": "netlify dev -c \"npm run dev:app\" --targetPort 8080",`
`9`	`9`	`"dev:app": "vite",`
`10`	`10`	`"dev:api": "npm run start --prefix api",`
`11`	`11`	`"test": "vitest run",`
`12`	`12`	`"check": "svelte-check --tsconfig ./tsconfig.json",`
	`13`	`+ "start:azure": "run-p dev:api dev:app",`
`13`	`14`	`"build:azure": "npx vite build",`
`14`	`15`	`"build:netlify": "npx vite build && cd api && npm i && npm run build"`
`15`	`16`	`},`

Comments

(0)