# Local setup

This guide aims users in setting up Inji Web for development. You can go through the instructions step-by-step to set up your machine up for development.

## Repositories:

Clone the repositories locally to bring up your own setup.

`https://github.com/mosip/inji-web.git`.

Refer to the [**release notes**](https://github.com/mosip/inji-web/releases) to know about the earlier releases.

**Pre-requisite:**

In order to run Inji Web locally, Node 18 is required. Please follow the below steps to install node.

Node 18 can be installed using [nvm](https://github.com/nvm-sh/nvm). Run the following commands to install node:

```bash
$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
$ nvm install 18
```

## Folder Structure:

* **helm:** folder contains helm charts required to deploy on K8S
* **inji-web:** contains the source code and Dockerfile
* **docker-compose:** contains docker-compose.yml, environment files, and service configurations.
* [README link](https://github.com/mosip/inji-web/blob/master/README.md)

***

## Run Inji Web locally using Docker Compose:

This setup uses Docker Compose to run **DataShare Service (Service to store VC)**, **Mimoto Service** (Backend for Frontend) and **Inji Web** (Frontend) together locally, providing a simple and easy-to-manage environment.

## Steps:

1. **Navigate to the `inji-web` folder and build the Inji Web image locally.**

```bash
cd ./inji-web
docker build -t inji-web:local .
```

2. **Prepare the environment:**
   * In the `docker-compose` folder, there are configuration files and certificates for integrating Mimoto as the BFF (Backend for Frontend) for the web and mobile services.
   * **Create a `certs` folder** in the `docker-compose` directory and add the necessary OIDC client certificate (as mentioned below).
   * **Update the configuration files:**
     * `mimoto-issuers-config.json` (Add Id providers as issuers)
     * `mimoto-trusted-verifiers.json` (Add verifiers clientId and redirect URI for online sharing)
     * Update **Esignet host references** in the `mimoto-default.properties`, `mimoto-issuers-config.json` files.
     * Set the `oidc_p12_password` environment variable value as per the documentation.
   * **Create OIDC client** and generate `oidckeystore.p12`. You can follow the setup guide for this process [here](https://docs.mosip.io/inji/inji-mobile-wallet/customization-overview/credential_providers).
   * **Update `mimoto-issuers-config.json`** with the client ID and client alias as per your OIDC onboarding.
3. **\[Optional] Configure Google OAuth Client Credentials**

   * Refer to the [How to create Google Client Credentials](#how-to-create-google-client-credentials) section below.
   * Add the generated credentials to docker-compose.yml:

   ```yaml
       environment:
       - GOOGLE_OAUTH_CLIENT_ID=<your-client-id>
       - GOOGLE_OAUTH_CLIENT_SECRET=<your-client-secret>
   ```
4. **Start the Docker Compose environment:**

```bash
cd docker-compose
docker-compose up -d
```

5. **Stop the Docker Compose environment:**

```bash
docker-compose down
```

***

## Run Inji Web locally (Non-Docker Compose Setup):

If you'd prefer to run Inji Web without Docker Compose, you can manually set up and run the app on your local machine.

1. **Navigate to the `inji-web` folder and install dependencies:**

```bash
cd ./inji-web
npm install
```

2. **Start the Inji Web application:**

```bash
npm start
```

3. **Troubleshooting CORS issues:**

   If you encounter CORS errors when running the web app locally, you will need to set up a proxy server and configure it to point to `https://api.collab.mosip.net` for Mimoto's API.

   * Follow this [guide](https://jakemccambley.medium.com/fixing-cors-errors-when-working-with-3rd-party-apis-a69dc5474804) to set up the proxy.
   * Once the proxy server is running, update the `Inji Web` app to use the proxy by modifying the `window.location.origin` in the `src/utils/api.ts` file.
4. **Run tests:**

```bash
npm test
```

***

## How to create Google Client Credentials

To enable Google OAuth2.0 authentication, follow these steps:

1. **Go to the Google Cloud Console**:
   * Visit [Google Cloud Console](https://console.cloud.google.com/).
2. **Create a New Project**:
   * If you don’t already have a project, create a new one by clicking on the project dropdown and selecting "New Project".
3. **Enable the OAuth Consent Screen**:
   * Navigate to "APIs & Services" > "OAuth consent screen".
   * Select "External" for the user type and configure the required fields (e.g., app name, support email, etc.).
   * Save the changes.
4. **Create OAuth 2.0 Credentials**:
   * Navigate to "APIs & Services" > "Credentials".
   * Click "Create Credentials" > "OAuth 2.0 Client IDs".
   * Select "Web application" as the application type.
5. **Configure Authorized JavaScript Origins**: Depending on your environment, use the following values:

   ```
   http://localhost:8099
   ```
6. **Configure Authorized Redirect URIs**:

   ```
   http://localhost:8099/v1/mimoto/oauth2/callback/google
   ```
7. **Save and Retrieve Client Credentials**:
   * After saving, you will receive a `Client ID` and `Client Secret`.

***

### Summary:

* **Docker Compose Setup**: This is the recommended setup for running Inji Web along with Mimoto locally.
* **Standalone Setup**: If you prefer, you can run Inji Web as a standalone Node.js application.


---

# 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://docs.inji.io/inji-wallet/inji-web/build-and-deploy/local-setup.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.