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.
This commit is contained in:
Wolvan 2022-02-04 22:54:01 +01:00
parent 7cc845b34b
commit 4788087a3e

View file

@ -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 ## Running your own instance of Poll.Horse
### Standalone ### Standalone
1. Make sure you have [Node](https://www.nodejs.org/) installed. 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 3. Extract the zip file anywhere
4. Open a shell in in the directory you just extracted to and run `npm i` 4. Open a shell in in the directory you just extracted to and run `npm i --production --ignore-scripts`
5. Run `npm run build` to build the project 5. Start the server with `npm start`
6. Start the server with `npm start` 6. List all available options with `npm start -- --help` or use shell options with `npm start -- <options>`
7. List all available options with `npm start -- --help` or use shell options with `npm start -- <options>`
### Docker ### Docker
1. Install [Docker](https://www.docker.com/get-started) 1. Install [Docker](https://www.docker.com/get-started)