# Repository Information

### Repository Information

This repository serves as a vital resource for developers and builders in the Haven1 ecosystem. It encompasses a range of key features, each with their specific file paths and direct links for easy access. Here's an organized list for convenience:8

<table><thead><tr><th>Feature</th><th width="253">Path</th><th>Link</th></tr></thead><tbody><tr><td><code>ProofOfIdentity</code> contract</td><td><code>contracts/proof-of-identity/ProofOfIdentity.sol</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/blob/main/contracts/proof-of-identity/ProofOfIdentity.sol">Link</a></td></tr><tr><td>Examples</td><td><code>contracts/proof-of-identity/examples/*</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/tree/main/contracts/proof-of-identity/examples">Link</a></td></tr><tr><td>Tests</td><td><code>test/proof-of-identity/*</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/tree/main/test/proof-of-identity">Link</a></td></tr><tr><td>Documentation</td><td><code>docs</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/tree/main/docs/proof-of-identity">Link</a></td></tr><tr><td>Utils</td><td><code>utils</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/tree/main/utils">Link</a></td></tr><tr><td>Templates</td><td><code>templates</code></td><td><a href="https://github.com/haven1network/proof-of-identity-hackathon/tree/main/templates">Link</a></td></tr></tbody></table>

All contracts have been extensively commented to aid in understanding the Haven1 Passport.

### Setting up a development environment

#### Installation Steps

Ensure that you have NodeJS installed on your system as it is essential for running and testing the framework.

#### Installation Steps

1. **Clone the Repository**: Start by cloning the repository to your local machine. This will give you access to all necessary files and documentation.

   ```bash
   git clone git@github.com:haven1network/proof-of-identity-hackathon.git
   ```
2. **Navigate to the Directory**: After cloning, change your current directory to the newly cloned repository.

   ```bash
   cd proof-of-identity
   ```
3. **Install Dependencies**: Install all required dependencies to ensure your environment is ready for development.

   ```bash
   npm i
   ```

This setup will provide you with all the tools and resources needed to develop and test applications utilizing Haven1's Passport. For additional guidance and documentation, refer to the repository's documentation section.