From 5ef292a482dbf441ee8adac89ae6143640a321da Mon Sep 17 00:00:00 2001 From: Yarmo Mackenbach Date: Fri, 15 Jan 2021 14:53:49 +0100 Subject: [PATCH] Clarify local dev steps --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 99e790b..119d004 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,12 @@ Please note that this project has a [Code of Conduct](https://codeberg.org/keyox To run Keyoxide locally on your machine for development: -- install NodeJS - - directly from their [website](https://nodejs.org/en/), or - - using [nvm](https://github.com/nvm-sh/nvm): `nvm install --lts; nvm use --lts` -- run the server with `npm run dev` +- install either + - NodeJS + - directly from their [website](https://nodejs.org/en/), or + - using [nvm](https://github.com/nvm-sh/nvm): `nvm install --lts; nvm use --lts` + - [yarn](https://yarnpkg.com/) +- install dependencies with `npm install` or `yarn` +- run the server with `npm dev` or `yarn dev` Keyoxide will now be available at [https://localhost:3000](https://localhost:3000)