diff --git a/README.md b/README.md index bf5ebd2..021f41e 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,27 @@ # excalidraw-room +The backend for collaboration in [Excalidraw](https://excalidraw.com). + ## Requirements -- [Node.js](https://nodejs.org/en/) -- [Google Cloud SDK](https://cloud.google.com/sdk/?hl=en_US) +- [Node.js](https://nodejs.org/) +- [Google Cloud SDK](https://cloud.google.com/sdk/) -## Install +## Install dependencies ``` yarn ``` -## Build - -``` -yarn build -``` - -## Run +## Run locally ``` yarn start ``` -## Deploy +Visit [`localhost:8080`](http://localhost:8080) to test it. + +## Deploy to GCP Make sure you have access to the [`excalidraw-room`](https://console.cloud.google.com/home/dashboard?project=excalidraw-room) project. diff --git a/package.json b/package.json index 04a0f8c..38cef86 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "prepare": "yarn gcp-build", "pretest": "yarn gcp-build", "prettier": "prettier \"**/*.{ts,md,json,yaml,yml}\"", - "start": "node ./index.js", + "start": "yarn build && node ./index.js", "test": "yarn prettier --list-different" }, "version": "1.0.0"