myriation/keyoxide-web
1
0
Fork 0
forked from Mirrors/keyoxide-web
Code Pull requests Activity

Add local development to README

Browse source
This commit is contained in:
Yarmo Mackenbach 2020-08-12 11:56:42 +02:00
parent 5a80a5163f
commit 254dfc4433
1 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -8,8 +8,6 @@
[Keyoxide](https://keyoxide.org) is a modern, secure and decentralized platform to prove your online identity. [Keyoxide](https://keyoxide.org) is a modern, secure and decentralized platform to prove your online identity.
## Self-hosting ## 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! 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 - 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. 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)