From 254dfc44334e4a4834df68876fa62977fa725188 Mon Sep 17 00:00:00 2001 From: Yarmo Mackenbach Date: Wed, 12 Aug 2020 11:56:42 +0200 Subject: [PATCH] Add local development to README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7040949..063cd51 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ [Keyoxide](https://keyoxide.org) is a modern, secure and decentralized platform to prove your online identity. - - ## Self-hosting Self-hosting Keyoxide is an important aspect of the project. Users need to trust the Keyoxide instance they're using to reliably verify identities. Making Keyoxide itself decentralized means no one needs to trust a central server. If a friend or family member is hosting a Keyoxide instance, it becomes much easier to trust the instance! @@ -52,3 +50,14 @@ Contributing to Keyoxide can happen in many forms: - Promoting decentralized identity and web3.0 Please note that this project has a [Code of Conduct](https://codeberg.org/keyoxide/web/src/branch/main/CODE_OF_CONDUCT.md) that all contributors agree to abide when participating. + +### Local development + +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 `node index.js` + +Keyoxide will now be available at [https://localhost:3000](https://localhost:3000)