From c541999eb345c11bb1e4e205161dc8b2fe9b8f6a Mon Sep 17 00:00:00 2001 From: Dimitrie Stefanescu Date: Tue, 19 Jan 2021 13:25:49 +0000 Subject: [PATCH] Update readme.md clarifies .env instructions --- packages/server/readme.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/packages/server/readme.md b/packages/server/readme.md index 895776402..2dcd87e7b 100644 --- a/packages/server/readme.md +++ b/packages/server/readme.md @@ -12,18 +12,22 @@ We're working to stabilize the 2.0 API, and until then there will be breaking ch ## Introduction -The Speckle Server is a node application. To start it locally, simply: +The Speckle Server is a node application. To start it locally: -- ensure you have a local instance of postgres & redis running +First, ensure you have postgres and redis ready and running: + +- ensure you have a local instance of postgres running - create a postgres db called `speckle2_dev` -- then run `npm install` -- finally `npm run dev` will start the server. +- ensure you have an instance of redis running + +Finally, in the `packages/server` folder: + +- copy the `.env-example` file to `.env`, +- open and edit the `.env` file, filling in the required variables, +- run `npm install`, +- finally `npm run dev`, - check `localhost:3000/graphql` out! -You can customise your local deployment by editing and filling in a `.env` file. To do so: - -- copy the `.env-example` file to `.env` -- open and edit the `.env` file. ## Developing