From 98c74ebcd1cf8f196d83496a57806d56d4e99291 Mon Sep 17 00:00:00 2001
From: kshitijrajsharma <skshitizraj@gmail.com>
Date: Mon, 24 Jul 2023 14:19:16 +0545
Subject: [PATCH] Added installation docs

---
 Readme.md                             |   5 ++
 docs/Docker-installation.md           | 124 ++++++++++++++++++++++++++
 frontend/{.env sample => .env_sample} |   0
 3 files changed, 129 insertions(+)
 create mode 100644 docs/Docker-installation.md
 rename frontend/{.env sample => .env_sample} (100%)

diff --git a/Readme.md b/Readme.md
index a8c6db0c..b47904f7 100644
--- a/Readme.md
+++ b/Readme.md
@@ -25,3 +25,8 @@ To eliminate model biases, fAIr is built to work with the local communities and
 See below a suggested product roadmap [subject to change] that provides high-level overview for planned work.
 ![image](https://user-images.githubusercontent.com/98902727/218769416-b3c71d3b-7c20-4d40-ab1e-88442d06445d.png)
 
+
+## Local Installation [DEV]
+
+Checkout Docker Installation [docs](./docs/Docker-installation.md)## Local Installation [DEV]
+
diff --git a/docs/Docker-installation.md b/docs/Docker-installation.md
new file mode 100644
index 00000000..e90ac797
--- /dev/null
+++ b/docs/Docker-installation.md
@@ -0,0 +1,124 @@
+Docker Compose is created with redis , worker , postgis database ,  api and frontend all in one making it easy for development . For production it is not recommended
+
+## [DEV] Installation With Docker 
+
+1. Clone Repo 
+
+    ```
+    git clone https://github.com/hotosm/fAIr.git
+    ```
+
+2. Get Docker Compose Installed 
+
+    If docker is not installed , Install it from [here](https://docs.docker.com/engine/install/) 
+    ```
+    docker-compose --version
+    ```
+
+3. Check your Graphics 
+
+    fAIr works best with graphics card. It is highly recommended to use graphics card . It might not work with CPU only . Nvidia Graphics cards are tested 
+
+    You need to make sure you can see your graphics card details and can be accessed through docker by installing necessary drivers
+
+    By following command you can see your graphics and graphics driver details 
+    ```
+    nvidia-smi
+    ```
+
+4. Clonse Base Model and Create RAMP_HOME
+
+    - Create a new folder called RAMP , outside fAIr
+
+        ```
+        mkdir ramp
+        ```
+    - Download BaseModel Checkpoint from [here](https://drive.google.com/file/d/1wvJhkiOrSlHmmvJ0avkAdu9sslFf5_I0/view?usp=sharing) 
+
+        ```
+        pip install gdown
+        gdown --fuzzy https://drive.google.com/file/d/1wvJhkiOrSlHmmvJ0avkAdu9sslFf5_I0/view?usp=sharing
+        ```
+    - Clone Ramp Code 
+
+        ```
+        git clone https://github.com/kshitijrajsharma/ramp-code-fAIr.git ramp-code
+        ```
+    - Unzip downloaded basemodel and move inside ramp-code/ramp
+
+        ```
+        unzip checkpoint.tf.zip -d ramp-code/ramp  
+        ```
+    - Export Env variable for RAMP_HOME 
+        Grab the file path of folder we created earlier ```ramp``` and export it as env variable
+        ```
+        export RAMP_HOME=/home/YOUR_RAMP_LOCATION
+        ```
+        eg : export RAMP_HOME=/home/kshitij/ramp
+
+5. Register your Local setup to OSM 
+
+    - Go to [OpenStreetMap](https://www.openstreetmap.org/) , Login/Create Account
+    - Click on your Profile and Hit ```My Settings```
+    - Navigate to ```Oauth2 Applications```
+    - Register new application 
+    - Check permissions for ```Read user preferences``` and Redirect URI to be ```http://127.0.0.1:3000/authenticate/``` , Give it name as ```fAIr Dev Local```
+    - You will get ```OSM_CLIENT_ID``` , ```OSM_CLIENT_SECRET``` Copy them 
+
+6. Create Env variables 
+    - Create a file ```.env``` in backend with [docker_sample_env](../backend/docker_sample_env) content 
+        ```
+        cp docker_sample_env .env
+        ```
+    - Fill out the details of ```OSM_CLIENT_ID``` &```OSM_CLIENT_SECRET``` in .env file and generate a unique key & paste it to ```OSM_SECRET_KEY``` (It can be random for dev setup)
+    
+        Leave rest of the items as it is unless you know what you are doing
+    - Export ```TRAINING_WORKSPACE``` Env
+        Training workspace is the folder where fAIr will store its training files 
+        for eg :
+        ```
+        export TRAINING_WORKSPACE=/home/kshitij/hotosm/fAIr/trainings
+        ```
+    - Create ```.env``` in /frontend
+        ```
+        cp .env_sample .env
+        ```
+        You can leave it as it is for dev setup
+    
+7. Build & Run containers 
+
+    ```
+    docker compose build
+    ```
+
+    ```
+    docker compose up
+    ```
+
+8. Run Migrations 
+
+    See Running containers grab their ID and launch bash to make migrations (This is needed for the first time to set database)
+
+        docker container ps
+
+    Grab Container ID & Open Bash
+
+        docker exec -it CONTAINER_ID bash
+
+
+    Once Bash is promoted hit following commands 
+
+        python manage.py makemigrations
+        python manage.py makemigrations login
+        python manage.py makemigrations login
+        python manage.py migrate
+
+9. Play and Develop 
+
+    Restart containers 
+
+    ```
+    docker compose restart
+    ```
+
+    Frontend will be available on 5000 port , Backend will be on 8000 , Flower will be on 5500 
\ No newline at end of file
diff --git a/frontend/.env sample b/frontend/.env_sample
similarity index 100%
rename from frontend/.env sample
rename to frontend/.env_sample