From c27d6c9d5910dc5acc23ccba707a4664d48244a7 Mon Sep 17 00:00:00 2001
From: Dipesh Lamichhane <ft9dipesh@gmail.com>
Date: Wed, 9 Apr 2025 10:51:06 +0545
Subject: [PATCH] chore: add install instructions to README

---
 .gitignore               |  3 ---
 .gitmodules              |  2 +-
 README.md                | 40 ++++++++++++++++++++++++++++++++++++++++
 src/po/locale_es.po      |  2 +-
 src/po/locale_fr.po      |  2 +-
 src/vendor/react-arsenal |  1 +
 6 files changed, 44 insertions(+), 6 deletions(-)
 create mode 160000 src/vendor/react-arsenal

diff --git a/.gitignore b/.gitignore
index 98608735..5f063dbe 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,9 +11,6 @@
 # production
 /build
 
-# submodule
-/src/vendor
-
 # misc
 .DS_Store
 .env
diff --git a/.gitmodules b/.gitmodules
index 8a801774..2de14e6d 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "src/vendor/react-arsenal"]
 	path = src/vendor/react-arsenal
-	url = git@gitlab.com:nepware-internals/react-arsenal.git
+	url = https://gitlab.com/nepware-internals/react-arsenal.git
diff --git a/README.md b/README.md
index a6571508..3190f9e0 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,46 @@ The Nexus Environmental Assessment Tool [(NEAT+)](https://www.neatplus.org) is d
 
 The NEAT+ client allows for users to access the NEAT+ content. Registered users can join or create organizations, create projects, and surveys. Various privacy settings allow for different levels of publicity. Results can be analysed by users, can be shared outside of the platform, and can be aggrigated for organisation-wide or sector-wide analysis.
 
+# Installation Instructions
+
+To get started follow the steps below:
+
+#### Clone the repository to your machine, along with its submodules:
+```
+git clone --recurse-submodules https://github.com/NeatPlus/client.git
+```
+
+#### Install the required dependencies by running the following command in the project root directory:
+```
+cd client && yarn
+```
+
+#### Setup your project environment:
+- Create a .env file in the project root directory and copy the environment variables from the .env.example file.
+- Enter the correct values for each variable, then save the .env file.
+
+#### Start the development server:
+
+```
+yarn start
+```
+
+This should open the development environment in your browser. You may also manually open the url:
+
+```
+http://localhost:3000/
+```
+
+### Main Dependencies
+
+- React: JavaScript library for building user interfaces.
+- React Router: Library that provides routing capabilities for React applications.
+- Sass: CSS preprocessor that compiles SCSS into standard CSS.
+- Redux: A library for managing and centralizing application state.
+
+> ##### For better code quality and consistency, ESLint (for Javascript linting) and Stylelint (for CSS/SCSS linting) are used.
+###### Make sure to install ESLint and Stylelint in your code editor for a smoother development process.
+
 # Development Timeline
 
 The content and features should be fully developed by the end of August 2022, with the potential for future development.
diff --git a/src/po/locale_es.po b/src/po/locale_es.po
index f3699c24..580e9973 100644
--- a/src/po/locale_es.po
+++ b/src/po/locale_es.po
@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
-"POT-Creation-Date: Mon Mar 03 2025 15:13:23 GMT+0545 (Nepal Time)\n"
+"POT-Creation-Date: Wed Apr 09 2025 11:30:20 GMT+0545 (Nepal Time)\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
diff --git a/src/po/locale_fr.po b/src/po/locale_fr.po
index f3699c24..580e9973 100644
--- a/src/po/locale_fr.po
+++ b/src/po/locale_fr.po
@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
-"POT-Creation-Date: Mon Mar 03 2025 15:13:23 GMT+0545 (Nepal Time)\n"
+"POT-Creation-Date: Wed Apr 09 2025 11:30:20 GMT+0545 (Nepal Time)\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
diff --git a/src/vendor/react-arsenal b/src/vendor/react-arsenal
new file mode 160000
index 00000000..e746e5b9
--- /dev/null
+++ b/src/vendor/react-arsenal
@@ -0,0 +1 @@
+Subproject commit e746e5b9d44c56398753541ebc33191157b58d10