keyoxide-web/README.md

# Keyoxide

[![Build Status](https://drone.keyoxide.org/api/badges/keyoxide/web/status.svg)](https://drone.keyoxide.org/keyoxide/web)
[![License](https://img.shields.io/badge/license-AGPL--v3-blue)](https://codeberg.org/keyoxide/web/src/branch/main/LICENSE)
[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/keyoxide/keyoxide?sort=semver)](https://hub.docker.com/r/keyoxide/keyoxide)
[![Docker Pulls](https://img.shields.io/docker/pulls/keyoxide/keyoxide)](https://hub.docker.com/r/keyoxide/keyoxide)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/247838?domain=https%3A%2F%2Ffosstodon.org&style=social)](https://fosstodon.org/@keyoxide)

[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!

### Docker

The Docker container allows you to easily self-host the [Keyoxide](https://keyoxide.org) project. To get started, simply run:

`docker run -d -p 3000:3000 keyoxide/keyoxide:stable`

Keyoxide will now be available by visiting http://localhost:3000.

## Contributing

Anyone can contribute if they'd like! No need to be a programmer or technically-oriented for that matter.

Contributing to Keyoxide can happen in many forms:

- Finding and reporting bugs
- Suggesting new features
- Improving documentation
- Writing code to fix bugs and features
- 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 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)
Initial commit 2020-06-25 10:01:06 -06:00			`# Keyoxide`

Fix drone badge 2020-08-13 01:57:15 -06:00			`[![Build Status](https://drone.keyoxide.org/api/badges/keyoxide/web/status.svg)](https://drone.keyoxide.org/keyoxide/web)`
Add links to badges 2020-08-12 04:19:49 -06:00			`[![License](https://img.shields.io/badge/license-AGPL--v3-blue)](https://codeberg.org/keyoxide/web/src/branch/main/LICENSE)`
			`[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/keyoxide/keyoxide?sort=semver)](https://hub.docker.com/r/keyoxide/keyoxide)`
			`[![Docker Pulls](https://img.shields.io/docker/pulls/keyoxide/keyoxide)](https://hub.docker.com/r/keyoxide/keyoxide)`
Fix link 2020-08-12 04:20:27 -06:00			`[![Mastodon Follow](https://img.shields.io/mastodon/follow/247838?domain=https%3A%2F%2Ffosstodon.org&style=social)](https://fosstodon.org/@keyoxide)`
Update README 2020-08-12 03:41:01 -06:00
Update URL of drone instance 2020-07-21 13:39:19 -06:00			`[Keyoxide](https://keyoxide.org) is a modern, secure and decentralized platform to prove your online identity.`
Initial commit 2020-06-25 10:01:06 -06:00
Update README 2020-08-12 03:41:01 -06:00			`## 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!`

			`### Docker`

			`The Docker container allows you to easily self-host the [Keyoxide](https://keyoxide.org) project. To get started, simply run:`

			`docker run -d -p 3000:3000 keyoxide/keyoxide:stable`

			`Keyoxide will now be available by visiting http://localhost:3000.`

Add CoC to README 2020-08-12 03:47:28 -06:00			`## Contributing`

Fix adding CoC 2020-08-12 03:48:31 -06:00			`Anyone can contribute if they'd like! No need to be a programmer or technically-oriented for that matter.`

Add CoC to README 2020-08-12 03:47:28 -06:00			`Contributing to Keyoxide can happen in many forms:`

			`- Finding and reporting bugs`
			`- Suggesting new features`
			`- Improving documentation`
			`- Writing code to fix bugs and features`
			`- Promoting decentralized identity and web3.0`
Fix adding CoC 2020-08-12 03:48:31 -06:00
			`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.`
Add local development to README 2020-08-12 03:56:42 -06:00
			`### Local development`

			`To run Keyoxide locally on your machine for development:`

Clarify local dev steps 2021-01-15 06:53:49 -07:00			`- 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`
Add local development to README 2020-08-12 03:56:42 -06:00
			`Keyoxide will now be available at [https://localhost:3000](https://localhost:3000)`