# Project Installation

1. **Clone the SSP Key Repository**

{% hint style="info" %}
Before cloning the repository, please make sure you have git installed in your local environment.

If you don't have git on your local machine please follow the link: <https://git-scm.com/>

Please use the installer and installation guide for your OS.
{% endhint %}

Open a terminal and run the following commands

```
mkdir ssp-key
cd ssp-key
git clone git@github.com:RunOnFlux/ssp-key.git
```

2. **Install SSP Key Dependencies**

In installing the project dependencies you may use yarn

{% hint style="info" %}
For installing yarn you must follow this guide:

<https://classic.yarnpkg.com/lang/en/docs/install>
{% endhint %}

Open a terminal and run the following command to install SSP Key dependencies

```
yarn
bundle update --bundler
yarn bundleinstall
yarn podinstall
```

**Running Test Cases**

To run SSP Key test cases, open a terminal and run the following command

```
yarn test
```

**Running the Server**

To run SSP Key server, open a terminal and run the following command

```
yarn start
```

**Running on Android**

Open a terminal and run the following command

```
yarn android
```

**Running on iOS**

```
yarn ios
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sspwallet.gitbook.io/docs/ssp-key-development/project-installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
