From 4788087a3e90e0acf9a31cfd584181de718aea06 Mon Sep 17 00:00:00 2001 From: Wolvan Date: Fri, 4 Feb 2022 22:54:01 +0100 Subject: [PATCH] Update README to mention release zip No longer must the project be built from source when downloading a release. The user only has to install the dependencies with npm. --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24615ea..7c33ed7 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,11 @@ This service offers an API to create and get the status of polls. The API Docs c ## Running your own instance of Poll.Horse ### Standalone 1. Make sure you have [Node](https://www.nodejs.org/) installed. -2. Download the latest release source code from [the releases page](https://github.com/Wolvan/poll.horse/releases/); +2. Download the latest release zip from [the releases page](https://github.com/Wolvan/poll.horse/releases/); 3. Extract the zip file anywhere -4. Open a shell in in the directory you just extracted to and run `npm i` -5. Run `npm run build` to build the project -6. Start the server with `npm start` -7. List all available options with `npm start -- --help` or use shell options with `npm start -- ` +4. Open a shell in in the directory you just extracted to and run `npm i --production --ignore-scripts` +5. Start the server with `npm start` +6. List all available options with `npm start -- --help` or use shell options with `npm start -- ` ### Docker 1. Install [Docker](https://www.docker.com/get-started)