> For the complete documentation index, see [llms.txt](https://geekyants-5.gitbook.io/flatandflatmates/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://geekyants-5.gitbook.io/flatandflatmates/installation.md).

# Installation

## What Prerequisite knowledge do you need to run this app ? <a href="#what-prerequisite-knowledge-do-you-need-to-run-this-app" id="what-prerequisite-knowledge-do-you-need-to-run-this-app"></a>

* ​[Node](https://nodejs.org/en/)​
* ​[Express](https://expressjs.com/)​
* ​[Socket.io](https://socket.io/)​
* ​[React](https://github.com/facebook/react)​
* ​[React-Native](https://facebook.github.io/react-native/)​
* ​[Mobx State Tree](https://github.com/mobxjs/mobx-state-tree)
* ​[NPM](https://www.npmjs.com/)​
* ​[Git](https://git-scm.com/)​

## Pre-Installed software <a href="#pre-installed-software" id="pre-installed-software"></a>

* v6.0>=node [Download](https://nodejs.org/en/download/releases/)​
* v4.0>=npm
* Cocoapods [Download](https://cocoapods.org/)​

{% hint style="success" %}
Compatible with node version 13.3.0
{% endhint %}

## Prerequisite Credentials you need to obtain in order to run this app <a href="#prerequisite-credentials-you-need-to-obtain-in-order-to-run-this-app" id="prerequisite-credentials-you-need-to-obtain-in-order-to-run-this-app"></a>

### App Ids for Mobile App in src/config <a href="#app-ids-for-mobile-app-in-src-config" id="app-ids-for-mobile-app-in-src-config"></a>

* Facebook Scheme
* Facebook App Id
* Facebook Display Name
* iOS Client Id Google
* Android Id Google
* Google Api Key
* Server Url
* One Signal Key

### Set credentials in API in file config/env <a href="#set-credentials-in-api-in-file-config-env" id="set-credentials-in-api-in-file-config-env"></a>

* Jwt Secret
* Mongo DB Name
* Port Number
* Cloudinary Name
* Cloudinary Api Key
* Cloudinary Api Secret