From b60fffe06bfc7855364ece5241b0fcf3000034c6 Mon Sep 17 00:00:00 2001
From: Momin Ahmad <39887628+mostarz93@users.noreply.github.com>
Date: Tue, 7 Mar 2023 13:37:11 -0500
Subject: [PATCH] Update README.md

added repo structure
---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 43a53e9c..ea8e279c 100644
--- a/README.md
+++ b/README.md
@@ -99,3 +99,33 @@ Sync with: `yarn syncDevLocales` **must provide api key**
 Check sync changes with: `yarn checkDevLocales`
 
 Download prod locales with: `yarn downloadProdLocales`
+
+
+
+## Repo Structure
+
+'''
+|
+|- public
+		|- locales = Where we store all copy translations that you see on the page
+| src
+		|- config = all env vars and constants
+		|- client = all React/HTML/CSS
+		|- tests = testing services
+		|- utils = small helper functinos throughout the codebase 
+		|- core
+				|- types = data structs for entire codebase
+							|- State = for redux state data structs
+							|- Service = Credit + Collateral + other services
+							|- CreditLine = anything related to credit specifically
+				|- frameworks = 3rd party dependency integrations (ethersjs, subgraph, blocknative)
+				|- services = Libs for composing frameworks in actions for users
+							|- Tx = sending txs
+							|- CreditLine = interacting with credit/debt positions
+							|- Collateral = interacting with line collateral (Spigot + Escrow)
+							|- OnchainMetadata = ens + abis + ?
+				|- store = Redux. dynamic state about marketplace, user, tokens, etc. + actions to query/interact
+
+'''
+
+