pinkdiamond1 / world-id-docs

Documentation for the World ID protocol.

World ID Docs

This repository contains the full documentation for the World ID protocol.

About World ID

World ID is a protocol that lets you prove a human is doing an action only once without revealing any personal data. Stop bots, stop abuse.

World ID uses a device called the Orb which takes a picture of a person's iris to verify they are a unique and alive human. The protocol uses Zero-knowledge proofs so no traceable information is ever public.

World ID is meant for on-chain web3 apps, traditional cloud applications, and even IRL verifications.

Getting started with World ID

Regardless of how you landed here, the easiest way to get started with World ID is through the the Dev Portal.

World ID Demos

Want to see World ID in action? We have a bunch of Examples.

📄 Documentation

We have comprehensive docs for World ID at https://id.worldcoin.org/docs.

🗣 Feedback

World ID is in Beta, help us improve! Please share feedback on your experience. You can find us on Discord, look for the #world-id channel. You can also open an issue or a PR directly on this repo.

🧑‍💻 Development & testing

To develop locally and contribute to our docs, you can simply follow these instructions after cloning the repo.

• Activate required Node version (16.x)

  nvm use # only if you are using nvm
  

• Install dependencies

  yarn install

• Run locally

  yarn start

• Open browser at http://localhost:3000

• To build the production bundle you can simply run.

  yarn build

✨ Contributors

Thanks to all the contributors who have made World ID possible!